Skip to main content

Public Management API

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.

caution

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.

Endpoints#

Detailed list of all available endpoints and schemas

Authentication#

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 colon : and Base64 encoded .

e.g: Basic MDhkN2UxMzYtZjE2OS02MzUyLTk5NmQtMjVkMGNmNzQ4ODFjO9

Create Public API credentials#

  1. Open your Public API credentials management page on the ConfigCat Dashboard

  2. Click + Add New Credentials, give it a name, hit Generate.

  3. 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 credential dialog you won't be able to access it again.

  4. 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.

Media types#

MediaContent-type
jsonapplication/json
json with HALapplication/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 client#

ConfigCat 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 20 per second and 500 per minute for each endpoint.
  • Let's get in touch if you have different requirements.

Examples#

Get your Products#

Sample request on how to get all your Products.

Endpoint#

GET https://api.configcat.com/v1/products

Detailed list of available endpoints

Request - cURL#

auth_credentials_in_base64="dGVzdDp0ZXN0"
curl -X GET \"https://api.configcat.com/v1/products" \-H "accept: text/plain" \-H "Authorization: Basic ${auth_credentials_in_base64}"

Response#

[{    "productId": "00d553ae-832b-5532-d8ad-9b2ae6ddfa11",    "name": "cat@example.com"}]

Updating a Feature Flag using SDK Key for identification#

A sample on how to switch on enableMyAwesomeFeature by updating a Feature Flag value from false to true.

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

Endpoint#

PUT https://api.configcat.com/v1/settings/{settingKeyOrId}/value

Detailed list of available endpoints

Request - cURL#

auth_credentials_in_base64="dGVzdDp0ZXN0"setting_key="enableMyAwesomeFeature"reason="Automate_Test_Run"SDK_KEY="#YOUR-SDK-KEY#"
curl -X PUT \"https://api.configcat.com/v1/settings/${setting_key}/value?reason=${reason}" \-H "X-CONFIGCAT-SDKKEY: ${SDK_KEY}" \-H "Authorization: Basic ${auth_credentials_in_base64}" \-H "Content-Type: application/json" \-d "{\"value\":true}"

Response#

When the update was successful HTTP/1.1 200 OK

{    "config": {        "configId": "8aea7255-6f50-4b4b-8a50-094f3ab95b31",        "name": "Live Demo Project"    },    "environment": {        "environmentId": "c37af0af-e693-47e2-8017-6b3de388a652",        "name": "Production"    },    "readOnly": false,    "setting": {        "settingId": 965497318,        "key": "enableMyAwesomeFeature",        "name": "Enable My Awesome Feature",        "hint": "",        "settingType": "boolean"    },    "integrationLinks": [],    "rolloutRules": [],    "rolloutPercentageItems": [],    "value": true}