APIHub
Back to Explore

ConfigCat Public Management API

The ConfigCat Public Management API provides programmatic administration of ConfigCat feature flags and configurations. It allows developers to manage organizations, products, environments, configs, feature flag settings and values, user segments, permissions, and audit logs.

Development
basic
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

359ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/v1/products/{productId}/environments

List Environments

  • productId (path, required) — The identifier of the Product.
POST

/v1/products/{productId}/environments

Create Environment

  • productId (path, required) — The identifier of the Product.
GET

/v1/products/{productId}/members

List Product Members

  • productId (path, required) — The identifier of the Product.
POST

/v1/products/{productId}/members/invite

Invite Member

  • productId (path, required) — The identifier of the Product.
POST

/v1/products/{productId}/segments

Create Segment

  • productId (path, required) — The identifier of the Product.
GET

/v1/products/{productId}/tags

List Tags

  • productId (path, required) — The identifier of the Product.
POST

/v1/products/{productId}/tags

Create Tag

  • productId (path, required) — The identifier of the Organization.
DELETE

/v1/segments/{segmentId}

Delete Segment

  • segmentId (path, required) — The identifier of the Segment.
GET

/v1/segments/{segmentId}

Get Segment

  • segmentId (path, required) — The identifier of the Segment.
PUT

/v1/segments/{segmentId}

Update Segment

  • segmentId (path, required) — The identifier of the Segment.
DELETE

/v1/settings/{settingId}

Delete Flag

  • settingId (path, required) — The identifier of the Setting.
GET

/v1/settings/{settingId}

Get Flag

  • settingId (path, required) — The identifier of the Setting.
PATCH

/v1/settings/{settingId}

Update Flag

  • settingId (path, required) — The identifier of the Setting.
DELETE

/v1/products/{productId}/members/{userId}

Delete Member from Product

  • productId (path, required) — The identifier of the Product.
  • userId (path, required) — The identifier of the Member.
GET

/v1/products/{productId}/permissions

List Permission Groups

  • productId (path, required) — The identifier of the Product.
POST

/v1/products/{productId}/permissions

Create Permission Group

  • productId (path, required) — The identifier of the Product.
GET

/v1/products/{productId}/segments

List Segments

  • productId (path, required) — The identifier of the Product.
GET

/v1/products/{productId}/configs

List Configs

  • productId (path, required) — The identifier of the Product.
POST

/v1/code-references

POST

/v1/code-references/delete-reports

DELETE

/v1/configs/{configId}

Delete Config

  • configId (path, required) — The identifier of the Config.
GET

/v1/configs/{configId}

Get Config

  • configId (path, required) — The identifier of the Config.
PUT

/v1/configs/{configId}

Update Config

  • configId (path, required) — The identifier of the Config.
GET

/v1/configs/{configId}/deleted-settings

List Deleted Settings

  • configId (path, required) — The identifier of the Config.
GET

/v1/configs/{configId}/environments/{environmentId}

Get SDK Key

  • configId (path, required) — The identifier of the Config.
  • environmentId (path, required) — The identifier of the Environment.
GET

/v1/configs/{configId}/environments/{environmentId}/values

Get values

  • configId (path, required) — The identifier of the Config.
  • environmentId (path, required) — The identifier of the Environment.
GET

/v1/configs/{configId}/settings

List Flags

  • configId (path, required) — The identifier of the Config.
POST

/v1/configs/{configId}/settings

Create Flag

  • configId (path, required) — The identifier of the Config.
DELETE

/v1/environments/{environmentId}

Delete Environment

  • environmentId (path, required) — The identifier of the Environment.
GET

/v1/environments/{environmentId}

Get Environment

  • environmentId (path, required) — The identifier of the Environment.
PUT

/v1/environments/{environmentId}

Update Environment

  • environmentId (path, required) — The identifier of the Environment.
DELETE

/v1/environments/{environmentId}/settings/{settingId}/integrationLinks/{integrationLinkType}/{key}

Delete Integration link

  • environmentId (path, required) — The identifier of the Environment.
  • settingId (path, required) — The id of the Setting.
  • integrationLinkType (path, required) — The integration's type.
  • key (path, required) — The key of the integration link.
POST

/v1/environments/{environmentId}/settings/{settingId}/integrationLinks/{integrationLinkType}/{key}

Add or update Integration link

  • environmentId (path, required) — The identifier of the Environment.
  • settingId (path, required) — The id of the Setting.
  • integrationLinkType (path, required) — The integration link's type.
  • key (path, required) — The key of the integration link.
GET

/v1/environments/{environmentId}/settings/{settingId}/value

Get value

  • environmentId (path, required) — The identifier of the Environment.
  • settingId (path, required) — The id of the Setting.
POST

/v1/products/{productId}/configs

Create Config

  • productId (path, required) — The identifier of the Product.
PATCH

/v1/environments/{environmentId}/settings/{settingId}/value

Update value

  • environmentId (path, required) — The identifier of the Environment.
  • settingId (path, required) — The id of the Setting.
  • reason (query) — The reason note for the Audit Log if the Product's "Config changes require a reason" preference is turned on.
PUT

/v1/environments/{environmentId}/settings/{settingId}/value

Replace value

  • environmentId (path, required) — The identifier of the Environment.
  • settingId (path, required) — The id of the Setting.
  • reason (query) — The reason note for the Audit Log if the Product's "Config changes require a reason" preference is turned on.
GET

/v1/integrationLink/{integrationLinkType}/{key}/details

Get Integration link

  • integrationLinkType (path, required) — The integration link's type.
  • key (path, required) — The key of the integration link.
POST

/v1/jira/Connect

POST

/v1/jira/environments/{environmentId}/settings/{settingId}/integrationLinks/{key}

  • environmentId (path, required) — The identifier of the Environment.
  • settingId (path, required) — The id of the Setting.
  • key (path, required) — The key of the integration link.
GET

/v1/me

Get authenticated user details

GET

/v1/organizations

List Organizations

GET

/v1/organizations/{organizationId}/auditlogs

List Audit log items for Organization

  • organizationId (path, required) — The identifier of the Organization.
  • productId (query) — The identifier of the Product.
  • configId (query) — The identifier of the Config.
  • environmentId (query) — The identifier of the Environment.
  • auditLogType (query) — Filter Audit logs by Audit log type.
  • fromUtcDateTime (query) — Filter Audit logs by starting UTC date.
  • toUtcDateTime (query) — Filter Audit logs by ending UTC date.
GET

/v1/organizations/{organizationId}/members

List Organization Members

  • organizationId (path, required) — The identifier of the Organization.
DELETE

/v1/organizations/{organizationId}/members/{userId}

Delete Member from Organization

  • organizationId (path, required) — The identifier of the Organization.
  • userId (path, required) — The identifier of the Member.
POST

/v1/organizations/{organizationId}/members/{userId}

Update Member Permissions

  • organizationId (path, required) — The identifier of the Organization.
  • userId (path, required) — The identifier of the Member.
POST

/v1/organizations/{organizationId}/products

Create Product

  • organizationId (path, required) — The identifier of the Organization.
DELETE

/v1/permissions/{permissionGroupId}

Delete Permission Group

  • permissionGroupId (path, required) — The identifier of the Permission Group.
GET

/v1/permissions/{permissionGroupId}

Get Permission Group

  • permissionGroupId (path, required) — The identifier of the Permission Group.
PUT

/v1/permissions/{permissionGroupId}

Update Permission Group

  • permissionGroupId (path, required) — The identifier of the Permission Group.
GET

/v1/products

List Products

DELETE

/v1/products/{productId}

Delete Product

  • productId (path, required) — The identifier of the Product.
GET

/v1/products/{productId}

Get Product

  • productId (path, required) — The identifier of the Product.
PUT

/v1/products/{productId}

Update Product

  • productId (path, required) — The identifier of the Product.
GET

/v1/products/{productId}/auditlogs

List Audit log items for Product

  • productId (path, required) — The identifier of the Product.
  • configId (query) — The identifier of the Config.
  • environmentId (query) — The identifier of the Environment.
  • auditLogType (query) — Filter Audit logs by Audit log type.
  • fromUtcDateTime (query) — Filter Audit logs by starting UTC date.
  • toUtcDateTime (query) — Filter Audit logs by ending UTC date.
GET

/v1/settings/{settingKeyOrId}/value

Get value

  • settingKeyOrId (path, required) — The key or id of the Setting.
  • X-CONFIGCAT-SDKKEY (header) — The ConfigCat SDK Key. (https://app.configcat.com/sdkkey)
PATCH

/v1/settings/{settingKeyOrId}/value

Update value

  • settingKeyOrId (path, required) — The key or id of the Setting.
  • reason (query) — The reason note for the Audit Log if the Product's "Config changes require a reason" preference is turned on.
  • X-CONFIGCAT-SDKKEY (header) — The ConfigCat SDK Key. (https://app.configcat.com/sdkkey)
PUT

/v1/settings/{settingKeyOrId}/value

Replace value

  • settingKeyOrId (path, required) — The key or id of the Setting.
  • reason (query) — The reason note for the Audit Log if the Product's "Config changes require a reason" preference is turned on.
  • X-CONFIGCAT-SDKKEY (header) — The ConfigCat SDK Key. (https://app.configcat.com/sdkkey)
DELETE

/v1/tags/{tagId}

Delete Tag

  • tagId (path, required) — The identifier of the Tag.
GET

/v1/tags/{tagId}

Get Tag

  • tagId (path, required) — The identifier of the Tag.
PUT

/v1/tags/{tagId}

Update Tag

  • tagId (path, required) — The identifier of the Tag.
GET

/v1/tags/{tagId}/settings

List Settings by Tag

  • tagId (path, required) — The identifier of the Tag.

62 endpoints auto-detected

Authentication

This API uses Basic authentication (a username and password).

curl -X GET \
  "https://api.configcat.com/v1/products/{productId}/environments"

api.configcat.com · HTTPS only