To access the ConfigCat platform programmatically. Its purpose is to provide the same functionality as the Dashboard UI only for tests, tools, or scripts.
You can Create, Read, Update and Delete your Feature Flags, Configs, Environments or Products within ConfigCat.
The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON and JSON+HAL format.
Please avoid using the Management API for feature flag evaluation, it is not designed to handle massive loads. For that, we have the CDN and the SDKs instead.
The API uses the 'Basic' HTTP Authentication Scheme.
Where a Basic auth user name and a
Basic auth password is passed in an
Authorization: Basic header joined by a single
: and Base64 encoded .
Create Public API credentials
Open your Public API credentials management page on the ConfigCat Dashboard
Click + Add New Credentials, give it a name, hit Generate.
Save your basic auth username and password to your favorite key-vault.
Due to security reasons we don't store your password, so if you close the dialog you won't be able to access it again.
Use username-password credentials with BASIC authentication in your HTTP requests.
Keep your credentials secure: do not embed it directly in your code and do not share it.
|json with HAL||application/hal+json|
The JSON Hypertext Application Language (HAL) is a standard which establishes conventions for expressing hypermedia controls, such as links, with JSON
Public API clients
You can create clients easily using Swagger Codegen.
Sample clientConfigCat Public API client for Angular
Throttling and rate limits
Do not use this API for accessing and evaluating feature flag values. Use the SDKs instead.
HTTP 429 - Too many requests status is returned in case throttling gets activated, along
with a reason message with details.
Public API rate limit policy
- You can expect the limits around
20per second and
500per minute for each endpoint.
- Let's get in touch if you have different requirements.
Get your Products
Sample request on how to get all your Products.
Request - cURL
Updating a Feature Flag using SDK Key for identification
A sample on how to switch on
enableMyAwesomeFeature by updating a
Feature Flag value from
This endpoint uses the
SDK_KEY in the Header to identify the Config and
Environment for the feature flag. So you don't need to get their IDs before
updating. Get your SDK Key
Request - cURL
When the update was successful
HTTP/1.1 200 OK