apimatic-semgrep-sdk 0.0.2

This is a sample API generated by APIMatic

Getting Started with Semgrep Web App

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

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install apimatic-semgrep-sdk==0.0.2

You can also view the package at: https://pypi.python.org/pypi/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
http_client_instance	Union[Session, HttpClientProvider]	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 30
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ["GET", "PUT"]
proxy_settings	ProxySettings	Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration	LoggingConfiguration	The SDK logging configuration for API calls
semgrep_admin_jwt_credentials	SemgrepAdminJwtCredentials	The credential object for OAuth 2 Bearer token
semgrep_jwt_credentials	SemgrepJwtCredentials	The credential object for OAuth 2 Bearer token
semgrep_web_token_credentials	SemgrepWebTokenCredentials	The credential object for OAuth 2 Bearer token

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from semgrepwebapp.configuration import Environment
from semgrepwebapp.http.auth.semgrep_admin_jwt import SemgrepAdminJwtCredentials
from semgrepwebapp.http.auth.semgrep_jwt import SemgrepJwtCredentials
from semgrepwebapp.http.auth.semgrep_web_token import SemgrepWebTokenCredentials
from semgrepwebapp.logging.configuration.api_logging_configuration import LoggingConfiguration
from semgrepwebapp.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from semgrepwebapp.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from semgrepwebapp.semgrepwebapp_client import SemgrepwebappClient

client = SemgrepwebappClient(
    semgrep_admin_jwt_credentials=SemgrepAdminJwtCredentials(
        access_token='AccessToken'
    ),
    semgrep_jwt_credentials=SemgrepJwtCredentials(
        access_token='AccessToken'
    ),
    semgrep_web_token_credentials=SemgrepWebTokenCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from semgrepwebapp.semgrepwebapp_client import SemgrepwebappClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = SemgrepwebappClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

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

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime