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

Install the gem from the command line:

gem install apimatic-semgrep-sdk -v 0.0.2

Or add the gem to your Gemfile and run bundle:

gem 'apimatic-semgrep-sdk', '0.0.2'

For additional gem details, see the RubyGems page for the apimatic-semgrep-sdk gem.

IRB Console Usage

You can explore the SDK interactively using IRB in two ways

1. Use IRB with Installed Gem

Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.

irb

Now you can load the SDK in the IRB

require 'semgrep_web_app'
include SemgrepWebApp

2. Use IRB within SDK

Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.

cd path/to/semgrep_web_app

Now you can start the preconfigured irb console by running the following command

ruby bin/console

Note: This automatically loads the SDK from lib/

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
connection Faraday::Connection The Faraday connection object passed by the SDK user for making requests
adapter Faraday::Adapter The Faraday adapter object passed by the SDK user for performing http requests
timeout Float The value to use for connection timeout.
Default: 30
max_retries Integer The number of times to retry an endpoint call if it fails.
Default: 0
retry_interval Float Pause in seconds between retries.
Default: 1
backoff_factor Float The amount to multiply each successive retry's interval amount by in order to provide backoff.
Default: 2
retry_statuses Array A list of HTTP statuses to retry.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array A list of HTTP methods to retry.
Default: %i[get put]
http_callback HttpCallBack The Http CallBack allows defining callables for pre and post API calls.
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

require 'semgrep_web_app'
include SemgrepWebApp

client = Client.new(
  semgrep_admin_jwt_credentials: SemgrepAdminJwtCredentials.new(
    access_token: 'AccessToken'
  ),
  semgrep_jwt_credentials: SemgrepJwtCredentials.new(
    access_token: 'AccessToken'
  ),
  semgrep_web_token_credentials: SemgrepWebTokenCredentials.new(
    access_token: 'AccessToken'
  ),
  environment: Environment::PRODUCTION,
  logging_configuration: LoggingConfiguration.new(
    log_level: Logger::INFO,
    request_logging_config: RequestLoggingConfiguration.new(
      log_body: true
    ),
    response_logging_config: ResponseLoggingConfiguration.new(
      log_headers: true
    )
  )
)

Environment-Based Client Initialization

require 'semgrep_web_app'
include SemgrepWebApp

# Create client from environment
client = Client.from_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.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities