Sigma's Swagger playground

Swagger allows you to use Sigma’s API directly from the browser. This article will walk you through authentication and endpoint usage in Swagger.

Take me directly to Swagger.

I prefer cURL.

Requirements

• You must have a valid API Token and Client ID; see Get an API Token and Client ID.

Authenticate with Swagger

1. Open Sigma’s Swagger page.

2. Near the top of the page under Server, select your organization’s host cloud platform.
   For GCP organizations, use

   https://api.sigmacomputing.com

   For AWS organizations, use

   https://aws-api.sigmacomputing.com

   Help me identify my cloud

3. Click the Authorize button on the right side of the page.

4. In the modal, enter your Client ID (client_id) and API Token (client_secret).

5. Click Authorize.
   Note: You will have access to Sigma's API for 1 hour. After that time, you will need to re-authorize. You can use the same Client ID and API Token each time.

6. Now what? Close the Authorize modal and click an endpoint on the page to begin trying it out.

Call Sigma’s API using Swagger

1. Click the endpoint you would like to call.
2. Under the endpoint, click Try it.
3. Enter the input needed for your API request.
   Note: Required and optional inputs are endpoint, and often request, specific.
4. Click Execute.
5. View the displayed response.