Prerequisites

Access Token

An Access Token is required to call Sifflet API endpoints.

Using the API Depending on Your Deployment Model

You can use Sifflet API endpoints regardless of your Sifflet deployment type (SaaS or self hosted).

SaaS

Simply follow the guidelines of the documentation page that corresponds to the API endpoint you are interested in querying.

Self Hosted

• Make sure your client is in a network that can access your Sifflet instance.
• The API is available at the same URL as the Sifflet UI:
  • For instance, if you're accessing the UI at https://sifflet.acme.com, then the URL to query all your sources is https://sifflet.acme.com/api/v2/sources.
• Note that if the team in charge of the Sifflet deployment at your company has set a specific value for the backendApiUrl Helm configuration value, then the Sifflet API may also be accessible at that url.
  • In this case, you need to omit the /api path from the API endpoints you want to query.
  • For instance, if the Sifflet deployment team set the backendApiUrlHelm value to https://api-sifflet.acme.com, then you can use the URL https://api-sifflet.acme.com/v2/sources to query all your sources.

Supported content-type

All Sifflet API endpoints support both the application/json and the application/x-yaml content-type.