1. API Overview

Flipt’s API is the primary way to interact with Flipt outside of the UI. It is used to create, update, and delete entities such as flags, segments, and rules. It is also used to evaluate flags.

The Flipt UI is completely backed by this same API. This means that anything that can be done in the Flipt UI can also be done via the REST API.

The Flipt REST API can also be used with any language that can make HTTP requests.

The latest version of the REST API is fully documented using the OpenAPI v3 specification.

There are also official client SDKs for JavaScript, Java, and Rust:

We’re working on more REST API SDKs and would love to hear from you if you’re interested in helping out or have a request for an SDK in a specific language.

Please reach out to us in our Discord server.

Authentication

Flipt authentication is disabled (not required) by default.

Head to the Configuration: Authentication section to enable it.

Once enabled, the Flipt REST API uses tokens for authentication. The token is passed in the Authorization header of the request as a Bearer token.

For more information on how to create a token, see the Authentication documentation.