API Reference
HomeChangelogBlog

Overview

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.
  • Confirm the URL of the Sifflet backend API with the team in charge of the Sifflet deployment at your company. Note that the Sifflet backend API URL should be defined by the backendApiUrl variable in the Helm release values.
  • Append the appropriate path and query parameters to this backend API URL. Example: If your Sifflet backend API URL is https://siffletapi.acme.com and you are looking to get all your Sifflet rules, the URL of the endpoint to query is https://siffletapi.acme.com/api/v1/rules.

Supported content-type

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