Sysdig API

Getting Started

Authentication

To use the APIs, you must authenticate with one of the following authentication options:

• Team-Based Service Account
• Global Service Account
• Sysdig API token (user-based)

To use any of the methods, set an Authorization header and provide a Bearer token:

Authorization: Bearer { team-based service account | global service account | api token }

Obtain the Sysdig API Token

See Retrieve the Sysdig API Token for instructions on retrieving the API token.

Obtain the Service Account

See Service Accounts for instructions on retrieving the Team-Based Service Account.

Authorization

The API documentation provides the permissions required to access a specific endpoint. Available permissions depend on the selected role. Not all permissions or roles are available for Team-Based Service Accounts because they are based on User (non-admin) roles.

See Understand Sysdig Users for more information.

Conventions

API access is over HTTPS. Data is sent and received primarily in JSON format.

HTTP PUT Request Method Convention

Ensure that you provide all fields in the endpoint when using the PUT method, unless otherwise specified in the API endpoint documentation.

Perform the HTTP GET request first to obtain the contents before making any changes.

See the endpoint documentation before using HTTP PUT method.

Access the Sysdig API Using the Regional Endpoints

Here is the list of links to the new standardized Sysdig API for each region:

Access the Documentation

On-Prem vs SaaS Versions

You must be logged in to the Sysdig product to access the documentation links.

• SaaS: Both “current” and “next gen” versions are available.
• On-Prem: Only the “current” version is available.

Access from the Sysdig UI

1. Log in to either Sysdig Monitor or Sysdig Secure and click the User menu at the bottom of the left navigation bar.

2. Look for the group labeled Help, where you will find two entries:

   • Next Gen API Docs - Updated and standardized Sysdig API documentation
   • Current API Docs - Current Sysdig API documentation

   

Access Next Gen API Documentation Using Regional Endpoints

Access Current API Documentation Using Regional Endpoints