Sysdig API

Sysdig provides REST APIs that enables you to programmatically access and manage Sysdig Monitor, Sysdig Secure, and Sysdig Platform.

API Documentation Status

Sysdig is actively working on improving the Sysdig API and the API documentation. Currently, there are two versions of the Sysdig API documentation:

  • Next Gen Sysdig API docs - The new set of standardized Sysdig API docs that are rapidly expanding to include the new API versions.
  • Current Sysdig API docs - Sysdig will be moving away from the current API docs as the new API versions get added and standardized. However, you can still use the current APIs until the new API versions are introduced.

Getting Started

Before accessing the API, ensure that you have either a Sysdig API token or a Team Based Service Account.

Obtain the Sysdig API Token

See Retrieve the Sysdig API Token for instructions on how to retrieve the API token.

Obtain the Service Account

See Service Accounts for instructions on how to retrieve the Team Based Service Account.

Authentication

There are two available authentication options:

  1. Team Based Service account
  2. User API token

You can use both by setting an Authorization header and providing a Bearer token:

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

Authorization

The permission required for accessing a specific endpoint is provided in the API documentation. Available permissions depend on the selected role. Not all permissions or roles are available for Team Based Service Accounts because they are based of User (non-admin) roles. See Understand Sysdig Users for more information.

Conventions

Access the API

API access is over HTTPS and accessed from:

Data is sent and received primarily in JSON format.

Convention for HTTP PUT Request Method Usage

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 New Standardized Sysdig API Using the Regional Endpoints

Here’s a list of links to the new standardized Sysdig API for each region:

RegionHostname
US-1https://api.us1.sysdig.com
US-2https://api.us2.sysdig.com
US-3https://api.us3.sysdig.com
US-4https://api.us4.sysdig.com
EU-1https://api.eu1.sysdig.com
AU-1https://api.au1.sysdig.com
ME-1https://api.me2.sysdig.com

Access the API Documentation

You can access the Sysdig API documentation from the Sysdig UI or by using the documentation links below.

In order to access the API documentation, you must be logged in to the Sysdig platform.

Access the API Documentation From the Sysdig UI

  1. Log in to Sysdig Platform.

  2. Click the User menu at the bottom of the left navigation bar.

  3. Look for the group labeled Help

  4. You will find two entries:

    • Next Gen API Docs - New standardized Sysdig API documentation
    • Current API Docs - Current Sysdig API documentation

Access the New Standardized Sysdig API Documentation Using the Regional Endpoints

Here’s a list of links to the new standardized Sysdig API documentation for each region:

RegionSecureMonitor
US-1https://secure.sysdig.com/apidocs/securehttps://app.sysdigcloud.com/apidocs/monitor
US-2https://us2.app.sysdig.com/apidocs/securehttps://us2.app.sysdig.com/apidocs/monitor
US-3https://app.us3.sysdig.com/apidocs/securehttps://app.us3.sysdig.com/apidocs/monitor
US-4https://app.us4.sysdig.com/apidocs/securehttps://app.us4.sysdig.com/apidocs/monitor
EU-1https://eu1.app.sysdig.com/apidocs/securehttps://eu1.app.sysdig.com/apidocs/monitor
AU-1https://app.au1.sysdig.com/apidocs/securehttps://app.au1.sysdig.com/apidocs/monitor
ME-2https://app.me2.sysdig.com/apidocs/securehttps://app.me2.sysdig.com/apidocs/monitor

Access the Current Sysdig API Documentation Using the Regional Endpoints

Here’s a list of links to the current Sysdig API documentation for each region:

RegionSecureMonitor
US-1https://secure.sysdig.com/secure/swagger.htmlhttps://app.sysdigcloud.com/api/public/docs/index.html
US-2https://us2.app.sysdig.com/secure/swagger.htmlhttps://us2.app.sysdig.com/api/public/docs/index.html
US-3https://app.us3.sysdig.com/secure/swagger.htmlhttps://app.us3.sysdig.com/api/public/docs/index.html
US-4https://app.us4.sysdig.com/secure/swagger.htmlhttps://app.us4.sysdig.com/api/public/docs/index.html
EU-1https://eu1.app.sysdig.com/secure/swagger.htmlhttps://eu1.app.sysdig.com/api/public/docs/index.html
AU-1https://app.au1.sysdig.com/secure/swagger.htmlhttps://app.au1.sysdig.com/api/public/docs/index.html
ME-2https://app.me2.sysdig.com/secure/swagger.htmlhttps://app.me2.sysdig.com/api/public/docs/index.html

For information on Sysdig SaaS regions, see SaaS Regions and IP Ranges.