The REST API

Experiments have been deprecated and Flags are the only entity in the system

  • The system is backwards compatible, but there are some critical issues to note until a new version of the Restful API is released:

    • Create an Experiment - creates a corresponding Flag, ignoring Experiment name.

    • Get Experiment - works as expected, ignoring Experiment name.

    • Patch Experiment - works as expected, ignoring Experiment name.

    • Get Experiments - returns only Flags that have at least one release rule configured.

    • Delete Experiment - removes a flag’s configuration and/or impression data, but does NOT delete the flag.

The REST API uses Rollout YAML and JSON files. See Configuration as Code for more information on YAML.

You can use the API to do the following:

  • push data into Rollout

  • get data out of Rollout

  • build custom integrations

  • build on top of the Rollout platform

Application ID

All resources are part of an application.

To find the Application ID :

  1. Click App Settings on the left panel on the Rollout dashboard.

  2. Click the Integrations tab.

Authentication

All requests to Rollout’s API must be authenticated with an API token.

API Token

Every Rollout user has an API token. The API token inherits the permission of its owner. The changelog shows the actions taken by the owner of the API token.

To find the API Token :

  1. Click App Settings on the left panel on the Rollout dashboard.

  2. Click the Integrations tab.

If you need to revoke a token please, contact support@rollout.io.

Authentication Header

You can authenticate with the API token by adding an authorization header containing your token.

Authorization: Bearer API_TOKEN