Sysdig API

API Documentation Status

Sysdig is actively working on improving the Sysdig API. There are two documentation versions:

• Next Gen Sysdig API docs — This includes new API versions standardized for both Sysdig Monitor and Sysdig Secure.
• Current Sysdig API docs — You can still use the current APIs until all the new API versions are introduced.

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

If you are using Sysdig SaaS, use the following links to access the standardized Sysdig API for each region:

Access the Sysdig APIs Using Hostname

If you are using Sysdig On-Prem, you can access public APIs use the Sysdig hostname.

Use the format https://api.sysdig.dnsName, where sysdig.dnsName is the hostname from the Installer values.

Access the Documentation

You can access the API docs through the UI or directly using the URL of your SaaS region or On-Prem installation.

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

If you are using Sysdig SaaS, you can access the Next Gen API documentation directly with the following links. The correct link will depend on your SaaS region. See SaaS Regions and IP Ranges for details.

Access Current API Documentation Using Regional Endpoints

If you are using Sysdig SaaS, you can access the Current API documentation directly with the following links. The correct link will depend on your SaaS region. See SaaS Regions and IP Ranges for details.