ConfigCat Public Management API
Base API URL: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The…
Developer tools#openapi#developer-tools
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Base API URL: https://api.configcat.com
If you prefer the swagger documentation, you can find it here: Swagger UI.
The purpose of this API is to access the ConfigCat platform programmatically.
You can Create, Read, Update and Delete any entities like 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. Do not use this API for accessing and evaluating feature flag values. Use the SDKs instead.
OpenAPI Specification
The complete specification is publicly available here: [swagger.json](v1/swagger.json).
You can use it to generate client libraries in various languages with OpenAPI Generator or
Swagger Codegen to interact with this API.
Authentication
This API uses the Basic HTTP Authentication Scheme.
-->
Throttling and rate limits
All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers:
| Header | Description |
|---|---|
| X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. |
| X-Rate-Limit-Reset | The time when the current rate limit period resets. |
When the rate limit is exceeded by a request, the API returns with a HTTP 429 - Too many requests status along with a Retry-After HTTP header.
Endpoints 62
Feature Flag & Setting values using SDK Key
- GETGet value
/v1/settings/:settingKeyOrId/valueThis endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the <a target="_blank" rel="noopener noreferrer"… - PUTReplace value
/v1/settings/:settingKeyOrId/value?reason=stringThis endpoint replaces the value of a Feature Flag or Setting in a specified Environment identified by the <a target="_blank" rel="noopener noreferrer"… - PATCHUpdate value
/v1/settings/:settingKeyOrId/value?reason=stringThis endpoint updates the value of a Feature Flag or Setting with a collection of JSON Patch operations in a specified Environment identified by the <a…
Feature Flag & Setting values
- GETGet values
/v1/configs/:configId/environments/:environmentId/valuesThis endpoint returns the value of a specified Config's Feature Flags or Settings identified by the configId parameter in a specified Environment identified… - GETGet value
/v1/environments/:environmentId/settings/:settingId/valueThis endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the environmentId parameter. The most important… - PUTReplace value
/v1/environments/:environmentId/settings/:settingId/value?reason=stringThis endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment. Only the value, rolloutRules and percentageRules attributes… - PATCHUpdate value
/v1/environments/:environmentId/settings/:settingId/value?reason=stringThis endpoint updates the value of a Feature Flag or Setting with a collection of JSON Patch operations in a specified Environment. Only the value,…
Feature Flags & Settings
- GETList Flags
/v1/configs/:configId/settingsThis endpoint returns the list of the Feature Flags and Settings defined in a specified Config, identified by the configId parameter. - POSTCreate Flag
/v1/configs/:configId/settingsThis endpoint creates a new Feature Flag or Setting in a specified Config identified by the configId parameter. Important: The key attribute must be unique… - GETGet Flag
/v1/settings/:settingIdThis endpoint returns the metadata attributes of a Feature Flag or Setting identified by the settingId parameter. - DELETEDelete Flag
/v1/settings/:settingIdThis endpoint removes a Feature Flag or Setting from a specified Config, identified by the configId parameter. - PATCHUpdate Flag
/v1/settings/:settingIdThis endpoint updates the metadata of a Feature Flag or Setting with a collection of JSON Patch operations in a specified Config. Only the name, hint and tags…
Organizations
- GETList Organizations
/v1/organizationsThis endpoint returns the list of the Organizations that belongs to the user.
Members
- GETList Organization Members
/v1/organizations/:organizationId/membersThis endpoint returns the list of Members that belongs to the given Organization, identified by the organizationId parameter. - POSTUpdate Member Permissions
/v1/organizations/:organizationId/members/:userIdThis endpoint adds a Member identified by the userId to one or more Permission Groups. This endpoint can also be used to move a Member between Permission… - DELETEDelete Member from Organization
/v1/organizations/:organizationId/members/:userIdThis endpoint removes a Member identified by the userId from the given Organization identified by the organizationId parameter. - GETList Product Members
/v1/products/:productId/membersThis endpoint returns the list of Members that belongs to the given Product, identified by the productId parameter. - POSTInvite Member
/v1/products/:productId/members/inviteThis endpoint invites a Member into the given Product identified by the productId parameter. - DELETEDelete Member from Product
/v1/products/:productId/members/:userIdThis endpoint removes a Member identified by the userId from the given Product identified by the productId parameter.
Permission Groups
- GETGet Permission Group
/v1/permissions/:permissionGroupIdThis endpoint returns the metadata of a Permission Group identified by the permissionGroupId. - PUTUpdate Permission Group
/v1/permissions/:permissionGroupIdThis endpoint updates a Permission Group identified by the permissionGroupId parameter. - DELETEDelete Permission Group
/v1/permissions/:permissionGroupIdThis endpoint removes a Permission Group identified by the permissionGroupId parameter. - GETList Permission Groups
/v1/products/:productId/permissionsThis endpoint returns the list of the Permission Groups that belongs to the given Product identified by the productId parameter, which can be obtained from… - POSTCreate Permission Group
/v1/products/:productId/permissionsThis endpoint creates a new Permission Group in a specified Product identified by the productId parameter, which can be obtained from the List Products…
Products
- POSTCreate Product
/v1/organizations/:organizationId/productsThis endpoint creates a new Product in a specified Organization identified by the organizationId parameter, which can be obtained from the List Organizations… - GETList Products
/v1/productsThis endpoint returns the list of the Products that belongs to the user. - GETGet Product
/v1/products/:productIdThis endpoint returns the metadata of a Product identified by the productId. - PUTUpdate Product
/v1/products/:productIdThis endpoint updates a Product identified by the productId parameter. - DELETEDelete Product
/v1/products/:productIdThis endpoint removes a Product identified by the productId parameter.
Configs
- GETGet Config
/v1/configs/:configIdThis endpoint returns the metadata of a Config identified by the configId. - PUTUpdate Config
/v1/configs/:configIdThis endpoint updates a Config identified by the configId parameter. - DELETEDelete Config
/v1/configs/:configIdThis endpoint removes a Config identified by the configId parameter. - GETList Configs
/v1/products/:productId/configsThis endpoint returns the list of the Configs that belongs to the given Product identified by the productId parameter, which can be obtained from the List… - POSTCreate Config
/v1/products/:productId/configsThis endpoint creates a new Config in a specified Product identified by the productId parameter, which can be obtained from the List Products endpoint.
Environments
- GETGet Environment
/v1/environments/:environmentIdThis endpoint returns the metadata of an Environment identified by the environmentId. - PUTUpdate Environment
/v1/environments/:environmentIdThis endpoint updates an Environment identified by the environmentId parameter. - DELETEDelete Environment
/v1/environments/:environmentIdThis endpoint removes an Environment identified by the environmentId parameter. - GETList Environments
/v1/products/:productId/environmentsThis endpoint returns the list of the Environments that belongs to the given Product identified by the productId parameter, which can be obtained from the… - POSTCreate Environment
/v1/products/:productId/environmentsThis endpoint creates a new Environment in a specified Product identified by the productId parameter, which can be obtained from the List Products endpoint.
Segments
- GETList Segments
/v1/products/:productId/segmentsThis endpoint returns the list of the Segments that belongs to the given Product identified by the productId parameter, which can be obtained from the List… - POSTCreate Segment
/v1/products/:productId/segmentsThis endpoint creates a new Segment in a specified Product identified by the productId parameter, which can be obtained from the List Products endpoint. - GETGet Segment
/v1/segments/:segmentIdThis endpoint returns the metadata of a Segment identified by the segmentId. - PUTUpdate Segment
/v1/segments/:segmentIdThis endpoint updates a Segment identified by the segmentId parameter. - DELETEDelete Segment
/v1/segments/:segmentIdThis endpoint removes a Segment identified by the segmentId parameter.
SDK Keys
- GETGet SDK Key
/v1/configs/:configId/environments/:environmentIdThis endpoint returns the SDK Key for your Config in a specified Environment.
Tags
- GETList Tags
/v1/products/:productId/tagsThis endpoint returns the list of the Tags in a specified Product, identified by the productId parameter. - POSTCreate Tag
/v1/products/:productId/tagsThis endpoint creates a new Tag in a specified Product identified by the productId parameter, which can be obtained from the List Products endpoint. - GETGet Tag
/v1/tags/:tagIdThis endpoint returns the metadata of a Tag identified by the tagId. - PUTUpdate Tag
/v1/tags/:tagIdThis endpoint updates a Tag identified by the tagId parameter. - DELETEDelete Tag
/v1/tags/:tagIdThis endpoint deletes a Tag identified by the tagId parameter. To remove a Tag from a Feature Flag or Setting use the Update Flag endpoint. - GETList Settings by Tag
/v1/tags/:tagId/settingsThis endpoint returns the list of the Settings that has the specified Tag, identified by the tagId parameter.
Audit logs
- GETList Deleted Settings
/v1/configs/:configId/deleted-settingsThis endpoint returns the list of Feature Flags and Settings that were deleted from the given Config. - GETList Audit log items for Organization
/v1/organizations/:organizationId/auditlogs?productId=3fa85f64-5717-4562-b3fc-2c963f66afa6&configId=3fa85f64-5717-4562-b3fc-2c963f66afa6&environmentId=3fa85f64-5717-4562-b3fc-2c963f66afa6&auditLogType=productCreated&fromUtcDateTime=2024-01-01T00:00:00Z&toUtcDateTime=2024-01-01T00:00:00ZThis endpoint returns the list of Audit log items for a given Organization and the result can be optionally filtered by Product and/or Config and/or… - GETList Audit log items for Product
/v1/products/:productId/auditlogs?configId=3fa85f64-5717-4562-b3fc-2c963f66afa6&environmentId=3fa85f64-5717-4562-b3fc-2c963f66afa6&auditLogType=productCreated&fromUtcDateTime=2024-01-01T00:00:00Z&toUtcDateTime=2024-01-01T00:00:00ZThis endpoint returns the list of Audit log items for a given Product and the result can be optionally filtered by Config and/or Environment.
Me
- GETGet authenticated user details
/v1/me
Code References
- POSTPOST /v1/code-references
/v1/code-references - POSTPOST /v1/code-references/delete-reports
/v1/code-references/delete-reports
Integration links
- POSTAdd or update Integration link
/v1/environments/:environmentId/settings/:settingId/integrationLinks/:integrationLinkType/:key - DELETEDelete Integration link
/v1/environments/:environmentId/settings/:settingId/integrationLinks/:integrationLinkType/:key - GETGet Integration link
/v1/integrationLink/:integrationLinkType/:key/details - POSTPOST /v1/jira/Connect
/v1/jira/Connect - POSTjira-add-or-update-integration-link
/v1/jira/environments/:environmentId/settings/:settingId/integrationLinks/:key
API details
- Base URL
https://api.configcat.com- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 62 operations on 36 pathsGET 27POST 14DELETE 10PUT 8PATCH 3
- Main resources
- Members 6Tags 6Configs 5Environments 5Feature Flags & Settings 5Integration links 5Permission Groups 5Products 5Segments 5Feature Flag & Setting values 4
- Response formats
application/hal+jsonapplication/json- Description format
- OpenAPI 3.0.1, API version
v1 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the ConfigCat Public Management API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the ConfigCat Public Management API collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get value” (GET /v1/settings/:settingKeyOrId/value), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the ConfigCat Public Management API?
Base API URL: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The… It is listed under Developer tools and has 62 endpoints.
Who publishes the ConfigCat Public Management API?
It is listed from ConfigCat's public API description (an OpenAPI document), not published by ConfigCat on Swastik Codes. Anyone who controls configcat.com can claim the profile by adding a DNS TXT record.
What is the base URL of the ConfigCat Public Management API?
Requests go to https://api.configcat.com. Endpoint paths are added to this base URL.
How do I authenticate with the ConfigCat Public Management API?
With HTTP Basic authentication (username and password).
How many endpoints does the ConfigCat Public Management API have?
62 operations on 36 paths (27 GET, 14 POST, 10 DELETE, 8 PUT, 3 PATCH). The largest groups are Members, Tags, Configs, Environments.
Is forking the ConfigCat Public Management API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.