sdksio / apimatic-semgrep-sdk
This is a sample API generated by APIMatic
Requires
- php: ^7.2 || ^8.0
- ext-curl: *
- ext-json: *
- apimatic/core: ~0.3.17
- apimatic/core-interfaces: ~0.1.5
- apimatic/unirest-php: ^4.0.6
Requires (Dev)
- phan/phan: 5.4.5
- squizlabs/php_codesniffer: ^3.5
README
Introduction
Welcome to Semgrep's portal for the Semgrep AppSec Platform web API.
Introduction
Semgrep is a fast, open-source, static analysis tool for finding bugs and enforcing code standards at editor, commit, and CI time. Get started.
This API is documented in the OpenAPI format.
Authentication
The API supports authentication with an API token with the "Web API" permission, without limited scopes of access.
You can provision an API token from the Settings page.
Terms of Use
Please note, the materials made available herein are subject to the Semgrep Terms of Use, and your access or use of any of the same is your acknowledgment and acceptance of the such terms.
Install the Package
Run the following command to install the package and automatically add the dependency to your composer.json file:
composer require "sdksio/apimatic-semgrep-sdk:0.0.2"
Or add it to the composer.json file manually as given below:
"require": { "sdksio/apimatic-semgrep-sdk": "0.0.2" }
You can also view the package at: https://packagist.org/packages/sdksio/apimatic-semgrep-sdk#0.0.2
Initialize the API Client
Note: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
| environment | Environment |
The API environment. Default: Environment.PRODUCTION |
| timeout | int |
Timeout for API calls in seconds. Default: 30 |
| enableRetries | bool |
Whether to enable retries and backoff feature. Default: false |
| numberOfRetries | int |
The number of retries to make. Default: 0 |
| retryInterval | float |
The retry time interval between the endpoint calls. Default: 1 |
| backOffFactor | float |
Exponential backoff factor to increase interval between retries. Default: 2 |
| maximumRetryWaitTime | int |
The maximum wait time in seconds for overall retrying requests. Default: 0 |
| retryOnTimeout | bool |
Whether to retry on request timeout. Default: true |
| httpStatusCodesToRetry | array |
Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524 |
| httpMethodsToRetry | array |
Http methods to retry against. Default: 'GET', 'PUT' |
| loggingConfiguration | LoggingConfigurationBuilder |
Represents the logging configurations for API calls |
| proxyConfiguration | ProxyConfigurationBuilder |
Represents the proxy configurations for API calls |
| semgrepAdminJwtCredentials | SemgrepAdminJwtCredentials |
The Credentials Setter for OAuth 2 Bearer token |
| semgrepJwtCredentials | SemgrepJwtCredentials |
The Credentials Setter for OAuth 2 Bearer token |
| semgrepWebTokenCredentials | SemgrepWebTokenCredentials |
The Credentials Setter for OAuth 2 Bearer token |
The API client can be initialized as follows:
use SemgrepWebAppLib\Logging\LoggingConfigurationBuilder; use SemgrepWebAppLib\Logging\RequestLoggingConfigurationBuilder; use SemgrepWebAppLib\Logging\ResponseLoggingConfigurationBuilder; use Psr\Log\LogLevel; use SemgrepWebAppLib\Environment; use SemgrepWebAppLib\Authentication\SemgrepAdminJwtCredentialsBuilder; use SemgrepWebAppLib\Authentication\SemgrepJwtCredentialsBuilder; use SemgrepWebAppLib\Authentication\SemgrepWebTokenCredentialsBuilder; use SemgrepWebAppLib\SemgrepWebAppClientBuilder; $client = SemgrepWebAppClientBuilder::init() ->semgrepAdminJwtCredentials( SemgrepAdminJwtCredentialsBuilder::init( 'AccessToken' ) ) ->semgrepJwtCredentials( SemgrepJwtCredentialsBuilder::init( 'AccessToken' ) ) ->semgrepWebTokenCredentials( SemgrepWebTokenCredentialsBuilder::init( 'AccessToken' ) ) ->environment(Environment::PRODUCTION) ->loggingConfiguration( LoggingConfigurationBuilder::init() ->level(LogLevel::INFO) ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true)) ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true)) ) ->build();
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| PRODUCTION | Default |
Authorization
This API uses the following authentication schemes.
SemgrepAdminJWT (OAuth 2 Bearer token)SemgrepJWT (OAuth 2 Bearer token)SemgrepWebToken (OAuth 2 Bearer token)
List of APIs
- Deployments Service
- Findings Service
- Misc Service
- Policies Service
- Projects Service
- Scans Service
- Secrets Service
- Supply Chain Service
- Ticketing Service
- Triage Service
SDK Infrastructure
Configuration
- ProxyConfigurationBuilder
- LoggingConfigurationBuilder
- RequestLoggingConfigurationBuilder
- ResponseLoggingConfigurationBuilder