The ConfigCat connector lets your AI agent work with ConfigCat. Scalekit handles authentication for every call, so your agent never handles credentials. It comes with 59 tools.
- Tools
- 59
- What they doRead · write · destructive
- 35 · 17 · 735 read17 write7 destructive
- Users sign in with
- Username and password
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the ConfigCat connection
In AgentKit > Connections, create a ConfigCat connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolconfigcat_config_getGet one config.Read-onlyGet Config
Get one config. Returns configId, name, description, order, evaluationVersion and product. Use configcat_configs_list to find IDs.
Inputs
config_idstringrequired- Config ID. Get it from configcat_configs_list. Example: 08d86d63-2726-47cd-8bfc-59608ecb91e2.
configcat_config_values_getGet the values and targeting rules of every flag in a config for one environment (Config V2 format).Read-onlyGet Config Values
Get the values and targeting rules of every flag in a config for one environment (Config V2 format). Returns settingValues with each flag's defaultValue, targetingRules and setting info, plus the config and environment. Use this for an overview of an environment.
Inputs
config_idstringrequired- Config ID. Get it from configcat_configs_list. Example: 08d86d63-2726-47cd-8bfc-59608ecb91e2.
environment_idstringrequired- Environment ID. Get it from configcat_environments_list. Example: 08d86d63-272c-4355-8027-4b52787bc1bd.
configcat_configs_listList the configs (flag collections) in a product.Read-onlyList Configs
List the configs (flag collections) in a product. Returns each config's configId, name, description, order and evaluationVersion. Use this to find a config ID.
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
configcat_deleted_flags_listList the feature flags and settings that were deleted from a config.Read-onlyList Deleted Flags
List the feature flags and settings that were deleted from a config. Returns each deleted flag's settingId, key, name and settingType. Use this to audit removals.
Inputs
config_idstringrequired- Config ID. Get it from configcat_configs_list. Example: 08d86d63-2726-47cd-8bfc-59608ecb91e2.
configcat_environment_getGet one environment.Read-onlyGet Environment
Get one environment. Returns environmentId, name, color, description, order and product. Use configcat_environments_list to find IDs.
Inputs
environment_idstringrequired- Environment ID. Get it from configcat_environments_list. Example: 08d86d63-272c-4355-8027-4b52787bc1bd.
configcat_environments_listList the environments (such as Development, Staging, Production) in a product.Read-onlyList Environments
List the environments (such as Development, Staging, Production) in a product. Returns each environment's environmentId, name, color, description and order. Use this to find an environment ID.
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
configcat_flag_code_references_getGet where a feature flag is referenced in your code, as reported by the ConfigCat code scanner.Read-onlyGet Flag Code References
Get where a feature flag is referenced in your code, as reported by the ConfigCat code scanner. Returns repositories, branches, files and lines that use the flag. Use this before deleting a flag.
Inputs
setting_idintegerrequired- Numeric ID of the feature flag or setting. Get it from configcat_flags_list. Example: 1234.
configcat_flag_getGet one feature flag or setting's metadata.Read-onlyGet Flag
Get one feature flag or setting's metadata. Returns settingId, key, name, hint, settingType, order, tags and config. Use configcat_flag_value_get for its value in an environment.
Inputs
setting_idintegerrequired- Numeric ID of the feature flag or setting. Get it from configcat_flags_list. Example: 1234.
configcat_flag_value_getGet a flag's value and targeting rules in one environment (Config V2 format).Read-onlyGet Flag Value
Get a flag's value and targeting rules in one environment (Config V2 format). Returns defaultValue, targetingRules (conditions, segments, percentage options), percentageEvaluationAttribute, setting info and readOnly. Use this before changing a value.
Inputs
environment_idstringrequired- Environment ID. Get it from configcat_environments_list. Example: 08d86d63-272c-4355-8027-4b52787bc1bd.
setting_idintegerrequired- Numeric ID of the feature flag or setting. Get it from configcat_flags_list. Example: 1234.
configcat_flags_by_tag_listList the feature flags and settings that carry a tag.Read-onlyList Flags by Tag
List the feature flags and settings that carry a tag. Returns each flag's settingId, key, name and settingType. Use configcat_tags_list to find tag IDs.
Inputs
tag_idintegerrequired- Numeric tag ID from configcat_tags_list. Example: 42.
configcat_flags_listList the feature flags and settings in a config.Read-onlyList Flags
List the feature flags and settings in a config. Returns each flag's settingId, key, name, hint, settingType, order and tags. Use this to find a setting ID or key. Use configcat_config_values_get for their values.
Inputs
config_idstringrequired- Config ID. Get it from configcat_configs_list. Example: 08d86d63-2726-47cd-8bfc-59608ecb91e2.
configcat_integrations_listList the third-party integrations (such as Slack, Datadog or Amplitude) set up in a product.Read-onlyList Integrations
List the third-party integrations (such as Slack, Datadog or Amplitude) set up in a product. Returns each integration's ID, type, name, configs and environments. Use this to see where flag changes are sent.
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
configcat_me_getGet the ConfigCat user that owns the API credentials.Read-onlyGet Current User
Get the ConfigCat user that owns the API credentials. Returns the user's email and full name. Use this to check the connection works.
Inputs
This tool takes no inputs.
configcat_organization_audit_logs_listList audit log entries for an organization, optionally filtered by product, config, environment, type and date range.Read-onlyList Organization Audit Log
List audit log entries for an organization, optionally filtered by product, config, environment, type and date range. Returns entries with who changed what, when, and the change details, paged. Use configcat_product_audit_logs_list for one product.
Inputs
organization_idstringrequired- Organization ID. Get it from configcat_organizations_list. Example: 08d8bd1f-5a0b-4b8c-8c43-2c6b5a8e9f01.
audit_log_typestring- Filter Audit logs by Audit log type. Example: settingValueChanged.
config_idstring- Config ID. Get it from configcat_configs_list. Example: 08d86d63-2726-47cd-8bfc-59608ecb91e2.
environment_idstring- Environment ID. Get it from configcat_environments_list. Example: 08d86d63-272c-4355-8027-4b52787bc1bd.
from_utc_date_timestring- Filter Audit logs by starting UTC date. Example: 2026-11-01T00:00:00Z.
page_numberinteger- Page number (min: 1). Defaults to 1. Example: 1.
page_sizeinteger- Page size (min: 1, max: 100). Defaults to 100. Example: 100.
product_idstring- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
to_utc_date_timestring- Filter Audit logs by ending UTC date. Example: 2026-11-30T23:59:59Z.
configcat_organization_invitations_listList pending invitations to an organization.Read-onlyList Organization Invitations
List pending invitations to an organization. Returns each invitation's ID, email, product and permission group. Use this to see who has not accepted yet.
Inputs
organization_idstringrequired- Organization ID. Get it from configcat_organizations_list. Example: 08d8bd1f-5a0b-4b8c-8c43-2c6b5a8e9f01.
configcat_organization_limitations_getGet the plan limits of an organization.Read-onlyGet Organization Limits
Get the plan limits of an organization. Returns the maximum numbers of products, configs, environments, flags, segments and similar. Use this before creating many resources.
Inputs
organization_idstringrequired- Organization ID. Get it from configcat_organizations_list. Example: 08d8bd1f-5a0b-4b8c-8c43-2c6b5a8e9f01.
configcat_organization_members_listList the members of an organization with their product permissions.Read-onlyList Organization Members
List the members of an organization with their product permissions. Returns admins and members with userId, email, fullName, two-factor status and their permission groups per product. Results depend on the caller's own permissions.
Inputs
organization_idstringrequired- Organization ID. Get it from configcat_organizations_list. Example: 08d8bd1f-5a0b-4b8c-8c43-2c6b5a8e9f01.
configcat_organizations_listList the ConfigCat organizations the credentials can access.Read-onlyList Organizations
List the ConfigCat organizations the credentials can access. Returns each organization's organizationId and name. Use this to find the organization ID for products, members and audit logs.
Inputs
This tool takes no inputs.
configcat_permission_group_getGet one permission group with its permissions per environment.Read-onlyGet Permission Group
Get one permission group with its permissions per environment. Returns permissionGroupId, name, permission flags and environment access. Use configcat_permission_groups_list to find IDs.
Inputs
permission_group_idintegerrequired- Numeric permission group ID from configcat_permission_groups_list. Example: 15.
configcat_permission_groups_listList the permission groups in a product.Read-onlyList Permission Groups
List the permission groups in a product. Returns each group's permissionGroupId, name and the permissions it grants. Use this to understand who can change what.
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
configcat_predefined_variations_getGet the predefined variations a flag can take.Read-onlyGet Predefined Variations
Get the predefined variations a flag can take. Returns each variation's ID, value, name and hint. Use these values when setting targeting rules.
Inputs
setting_idintegerrequired- Numeric ID of the feature flag or setting. Get it from configcat_flags_list. Example: 1234.
configcat_product_audit_logs_listList audit log entries for one product, optionally filtered by config, environment, type and date range.Read-onlyList Product Audit Log
List audit log entries for one product, optionally filtered by config, environment, type and date range. Returns entries with who changed what, when, and the change details, paged. Use this to see recent flag changes.
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
audit_log_typestring- Filter Audit logs by Audit log type. Example: settingValueChanged.
config_idstring- Config ID. Get it from configcat_configs_list. Example: 08d86d63-2726-47cd-8bfc-59608ecb91e2.
environment_idstring- Environment ID. Get it from configcat_environments_list. Example: 08d86d63-272c-4355-8027-4b52787bc1bd.
from_utc_date_timestring- Filter Audit logs by starting UTC date. Example: 2026-11-01T00:00:00Z.
page_numberinteger- Page number (min: 1). Defaults to 1. Example: 1.
page_sizeinteger- Page size (min: 1, max: 100). Defaults to 100. Example: 100.
to_utc_date_timestring- Filter Audit logs by ending UTC date. Example: 2026-11-30T23:59:59Z.
configcat_product_getGet one ConfigCat product.Read-onlyGet Product
Get one ConfigCat product. Returns the product's productId, name, description, order and organization. Use configcat_products_list to find IDs.
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
configcat_product_invitations_listList pending invitations to a product.Read-onlyList Product Invitations
List pending invitations to a product. Returns each invitation's ID, email and permission group. Use this to see who has not accepted yet.
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
configcat_product_members_listList the members of a product and their permission groups.Read-onlyList Product Members
List the members of a product and their permission groups. Returns userId, email, fullName and permissionGroupId for each member. Use configcat_organization_members_list for the whole organization.
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
configcat_product_preferences_getGet a product's preferences.Read-onlyGet Product Preferences
Get a product's preferences. Returns settings such as whether config changes require a reason, key generation mode, and per-environment approval rules. Check this before changing values: if a reason is required, pass reason to the value tools.
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
configcat_products_listList the ConfigCat products the credentials can access.Read-onlyList Products
List the ConfigCat products the credentials can access. Returns each product's productId, name, description, order and organization. Use this to find a product ID.
Inputs
This tool takes no inputs.
configcat_sdk_keys_getGet the SDK keys an application uses to read a config in one environment.Read-onlyGet SDK Keys
Get the SDK keys an application uses to read a config in one environment. Returns primary and secondary SDK keys. Use this to configure a ConfigCat SDK.
Inputs
config_idstringrequired- Config ID. Get it from configcat_configs_list. Example: 08d86d63-2726-47cd-8bfc-59608ecb91e2.
environment_idstringrequired- Environment ID. Get it from configcat_environments_list. Example: 08d86d63-272c-4355-8027-4b52787bc1bd.
configcat_segment_getGet one user segment with its rule.Read-onlyGet Segment
Get one user segment with its rule. Returns segmentId, name, description, comparisonAttribute, comparator, comparisonValue and usage. Use configcat_segments_list to find IDs.
Inputs
segment_idstringrequired- Segment ID from configcat_segments_list. Example: 08d9c4f0-1a2b-4c3d-8e4f-5a6b7c8d9e0f.
configcat_segments_listList the user segments in a product.Read-onlyList Segments
List the user segments in a product. Returns each segment's segmentId, name and description. Use configcat_segment_get for a segment's rule.
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
configcat_stale_flags_listList zombie (stale) feature flags in a product that have not changed for a given number of days.Read-onlyList Stale Flags
List zombie (stale) feature flags in a product that have not changed for a given number of days. Returns configs with their stale flags, each with key, name, last-change date and environments. Use this for flag cleanup.
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
ignored_environment_idsarray- Ignore environment identifiers from the report. Example: ["08d86d63-272c-4355-8027-4b52787bc1bd"]
ignored_tag_idsarray- Ignore feature flags from the report based on their tag identifiers. Example: [42]
scopestring- The scope of the report. Example: all.one of
allwatchedByMe stale_flag_age_daysinteger- The inactivity in days after a feature flag should be considered stale. Example: 30.
stale_flag_stale_in_environments_typestring- Consider a feature flag as stale if the feature flag is stale in all/any of the environments. Example: staleInAnyEnvironments.one of
staleInAnyEnvironmentsstaleInAllEnvironments
configcat_tag_getGet one tag.Read-onlyGet Tag
Get one tag. Returns tagId, name, color and product. Use configcat_tags_list to find IDs.
Inputs
tag_idintegerrequired- Numeric tag ID from configcat_tags_list. Example: 42.
configcat_webhook_getGet one webhook.Read-onlyGet Webhook
Get one webhook. Returns webhookId, url, httpMethod, content, headers (secure values hidden), config and environment. Use configcat_webhooks_list to find IDs.
Inputs
webhook_idintegerrequired- Numeric webhook ID from configcat_webhooks_list. Example: 77.
configcat_webhooks_listList the webhooks in a product.Read-onlyList Webhooks
List the webhooks in a product. Returns each webhook's webhookId, url, httpMethod, content, config and environment. Use this to find a webhook ID.
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
configcat_config_createCreate a config (a collection of feature flags and settings) in a product.WriteCreate Config
Create a config (a collection of feature flags and settings) in a product. Returns the new config with its configId. Then create flags in it with configcat_flag_create.
Inputs
namestringrequired- Name of the config. Example: Main config.
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
descriptionstring- Description of the config. Example: Used by the iOS and Android apps.
evaluation_versionstring- Config format: v1, or v2 for Config V2 features (segments and prerequisite flags in rules). Example: v2.one of
v1v2 orderinteger- Position on the ConfigCat dashboard (ascending). Example: 1.
configcat_config_updateUpdate a config's name, description or order.WriteUpdate Config
Update a config's name, description or order. Returns the updated config. Fields you leave out keep their values.
- Idempotent
Inputs
config_idstringrequired- Config ID. Get it from configcat_configs_list. Example: 08d86d63-2726-47cd-8bfc-59608ecb91e2.
descriptionstring- Description of the config. Example: Used by the iOS and Android apps.
namestring- Name of the config. Example: Main config.
orderinteger- Position on the ConfigCat dashboard (ascending). Example: 1.
configcat_config_values_updateUpdate the values and targeting rules of several flags in a config and environment in one call.WriteUpdate Config Values
Update the values and targeting rules of several flags in a config and environment in one call. Each listed flag is replaced; unlisted flags are untouched. Returns the config's updated values. Use configcat_flag_value_replace for one flag.
Inputs
config_idstringrequired- Config ID. Get it from configcat_configs_list. Example: 08d86d63-2726-47cd-8bfc-59608ecb91e2.
environment_idstringrequired- Environment ID. Get it from configcat_environments_list. Example: 08d86d63-272c-4355-8027-4b52787bc1bd.
update_formulasarrayrequired- One entry per flag to change, each with settingId, defaultValue and optional targetingRules and percentageEvaluationAttribute. Example: [{"settingId": 1234, "defaultValue": {"boolValue": true}}]
bypass_approvalboolean- Whether to bypass the approval process and directly apply the change. This is only applicable for users with bypass approval permission. Example: false.
latest_version_idstring- Optional. The version identifier of the last change made to the Feature Flag or Setting in the Environment. It can be used to make sure concurrent updates are not overwriting each other. If provided and the version identifier does not match the current version, the update will be rejected with a 409 Conflict response. The latest version id can be acquired from the LastVersionId property of the response models. Example: a1b2c3d4-e5f6-4789-9abc-def012345678.
reasonstring- The reason note for the Audit Log if the Product's "Config changes require a reason" preference is turned on. Example: Enable for beta users.
configcat_environment_createCreate an environment in a product.WriteCreate Environment
Create an environment in a product. Returns the new environment with its environmentId. Each config gets an SDK key per environment (configcat_sdk_keys_get).
Inputs
namestringrequired- Name of the environment. Example: Staging.
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
colorstring- Environment color as an RGB or HTML color code. Example: #4caf50.
descriptionstring- Description of the environment. Example: Used by the iOS and Android apps.
orderinteger- Position on the ConfigCat dashboard (ascending). Example: 1.
configcat_environment_updateUpdate an environment's name, color, description or order.WriteUpdate Environment
Update an environment's name, color, description or order. Returns the updated environment. Fields you leave out keep their values.
- Idempotent
Inputs
environment_idstringrequired- Environment ID. Get it from configcat_environments_list. Example: 08d86d63-272c-4355-8027-4b52787bc1bd.
colorstring- Environment color as an RGB or HTML color code. Example: #4caf50.
descriptionstring- Description of the environment. Example: Used by the iOS and Android apps.
namestring- Name of the environment. Example: Staging.
orderinteger- Position on the ConfigCat dashboard (ascending). Example: 1.
configcat_flag_createCreate a feature flag or setting in a config, optionally with initial values per environment.WriteCreate Flag
Create a feature flag or setting in a config, optionally with initial values per environment. Returns the new flag with its settingId. The key must be unique in the config and is what SDKs use.
Inputs
config_idstringrequired- Config ID. Get it from configcat_configs_list. Example: 08d86d63-2726-47cd-8bfc-59608ecb91e2.
keystringrequired- Key SDKs use to read it; unique within the config. Example: isAwesomeFeatureEnabled.
namestringrequired- Display name. Example: Awesome feature.
setting_typestringrequired- Value type: boolean, string, int or double. Example: boolean.one of
booleanstringintdouble hintstring- Short description shown on the dashboard. Example: Turns the new checkout on.
initial_valuesarray- Starting value per environment, each with environmentId and value. Example: [{"environmentId": "08d86d63-272c-4355-8027-4b52787bc1bd", "value": false}]
is_jsonboolean- For string settings: validate values as JSON. Example: false.
orderinteger- Position on the dashboard. Example: 1.
predefined_variationsarray- Predefined variations the flag can take, each with value, name and hint. Example: [{"value": {"stringValue": "blue"}, "name": "Blue"}]
setting_id_to_init_frominteger- Copy values and tags from this existing setting instead of initial_values. Example: 1234.
tagsarray- Tag IDs to attach. Example: [42]
configcat_flag_updateUpdate a flag's name, hint, order or tags with JSON Patch operations.WriteUpdate Flag Metadata
Update a flag's name, hint, order or tags with JSON Patch operations. Values are changed with the value tools. Returns the updated flag. Only name, hint, order and tags can be patched.
Inputs
operationsarrayrequired- JSON Patch operations, each with op (add, remove, replace, move, copy, test), path and value. Example: [{"op": "replace", "path": "/name", "value": "New name"}]
setting_idintegerrequired- Numeric ID of the feature flag or setting. Get it from configcat_flags_list. Example: 1234.
configcat_flag_value_replaceReplace a flag's default value and all its targeting rules in one environment.WriteReplace Flag Value
Replace a flag's default value and all its targeting rules in one environment. Anything you leave out is removed. Returns the new value and rules. Use configcat_flag_value_update to change just part of it, such as turning a flag on.
- Idempotent
Inputs
default_valueobjectrequired- Served value when no rule matches: one of boolValue, stringValue, intValue or doubleValue. Example: {"boolValue": true}
environment_idstringrequired- Environment ID. Get it from configcat_environments_list. Example: 08d86d63-272c-4355-8027-4b52787bc1bd.
setting_idintegerrequired- Numeric ID of the feature flag or setting. Get it from configcat_flags_list. Example: 1234.
bypass_approvalboolean- Whether to bypass the approval process and directly apply the change. This is only applicable for users with bypass approval permission. Example: false.
latest_version_idstring- Optional. The version identifier of the last change made to the Feature Flag or Setting in the Environment. It can be used to make sure concurrent updates are not overwriting each other. If provided and the version identifier does not match the current version, the update will be rejected with a 409 Conflict response. The latest version id can be acquired from the LastVersionId property of the response models. Example: a1b2c3d4-e5f6-4789-9abc-def012345678.
percentage_evaluation_attributestring- User attribute used for percentage rollouts. Defaults to Identifier. Example: Identifier.
reasonstring- The reason note for the Audit Log if the Product's "Config changes require a reason" preference is turned on. Example: Enable for beta users.
targeting_rulesarray- Targeting rules in order, each with conditions (userCondition, segmentCondition or prerequisiteFlagCondition) and a value or percentageOptions. Example: [{"conditions": [{"userCondition": {"comparisonAttribute": "Email", "comparator": "containsAnyOf", "comparisonValue": {"listValue": [{"value": "@example.com"...
configcat_flag_value_updateChange part of a flag's value or targeting rules in one environment with JSON Patch operations, for example to turn a flag on.WriteUpdate Flag Value
Change part of a flag's value or targeting rules in one environment with JSON Patch operations, for example to turn a flag on. Returns the updated value and rules. Use configcat_flag_value_get to see the current structure.
Inputs
environment_idstringrequired- Environment ID. Get it from configcat_environments_list. Example: 08d86d63-272c-4355-8027-4b52787bc1bd.
operationsarrayrequired- JSON Patch operations on the value document, each with op, path and value. Example: [{"op": "replace", "path": "/defaultValue/boolValue", "value": true}]
setting_idintegerrequired- Numeric ID of the feature flag or setting. Get it from configcat_flags_list. Example: 1234.
bypass_approvalboolean- Whether to bypass the approval process and directly apply the change. This is only applicable for users with bypass approval permission. Example: false.
latest_version_idstring- Optional. The version identifier of the last change made to the Feature Flag or Setting in the Environment. It can be used to make sure concurrent updates are not overwriting each other. If provided and the version identifier does not match the current version, the update will be rejected with a 409 Conflict response. The latest version id can be acquired from the LastVersionId property of the response models. Example: a1b2c3d4-e5f6-4789-9abc-def012345678.
reasonstring- The reason note for the Audit Log if the Product's "Config changes require a reason" preference is turned on. Example: Enable for beta users.
configcat_product_createCreate a product in an organization.WriteCreate Product
Create a product in an organization. A product holds configs, environments, tags and segments. Returns the new product with its productId. Then create environments and configs in it.
Inputs
namestringrequired- Name of the product. Example: Mobile app.
organization_idstringrequired- Organization ID. Get it from configcat_organizations_list. Example: 08d8bd1f-5a0b-4b8c-8c43-2c6b5a8e9f01.
descriptionstring- Description of the product. Example: Used by the iOS and Android apps.
orderinteger- Position on the ConfigCat dashboard (ascending). Example: 1.
configcat_product_updateUpdate a product's name, description or order.WriteUpdate Product
Update a product's name, description or order. Returns the updated product. Fields you leave out keep their values.
- Idempotent
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
descriptionstring- Description of the product. Example: Used by the iOS and Android apps.
namestring- Name of the product. Example: Mobile app.
orderinteger- Position on the ConfigCat dashboard (ascending). Example: 1.
configcat_segment_createCreate a user segment (a reusable user group defined by one attribute rule) in a product.WriteCreate Segment
Create a user segment (a reusable user group defined by one attribute rule) in a product. Returns the new segment with its segmentId. Use it in targeting rules with a segmentCondition.
Inputs
comparatorstringrequired- Comparison operator, for example isOneOf, contains, semVerGreater or numberEquals (see the API reference for the full list). Example: contains.
comparison_attributestringrequired- User attribute the segment compares, such as Email or Country. Example: Email.
comparison_valuestringrequired- Value to compare the attribute with; comma-separated for isOneOf. Example: @example.com.
namestringrequired- Name of the segment. Example: Beta testers.
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
descriptionstring- Description of the segment. Example: Used by the iOS and Android apps.
configcat_segment_updateUpdate a user segment's name, description or rule.WriteUpdate Segment
Update a user segment's name, description or rule. Returns the updated segment. Fields you leave out keep their values.
- Idempotent
Inputs
segment_idstringrequired- Segment ID from configcat_segments_list. Example: 08d9c4f0-1a2b-4c3d-8e4f-5a6b7c8d9e0f.
comparatorstring- Comparison operator, for example isOneOf, contains, semVerGreater or numberEquals (see the API reference for the full list). Example: contains.
comparison_attributestring- User attribute the segment compares, such as Email or Country. Example: Email.
comparison_valuestring- Value to compare the attribute with; comma-separated for isOneOf. Example: @example.com.
descriptionstring- Description of the segment. Example: Used by the iOS and Android apps.
namestring- Name of the segment. Example: Beta testers.
configcat_tag_createCreate a tag in a product to label feature flags.WriteCreate Tag
Create a tag in a product to label feature flags. Returns the new tag with its tagId. Attach it to flags with configcat_flag_update or configcat_flag_create.
Inputs
namestringrequired- Name of the tag. Example: beta.
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
colorstring- Tag color: panther, whale, salmon, lizard, canary, koala or an HTML color code. Example: whale.
configcat_tag_updateUpdate a tag's name or color.WriteUpdate Tag
Update a tag's name or color. Returns the updated tag. Fields you leave out keep their values.
- Idempotent
Inputs
tag_idintegerrequired- Numeric tag ID from configcat_tags_list. Example: 42.
colorstring- Tag color: panther, whale, salmon, lizard, canary, koala or an HTML color code. Example: whale.
namestring- Name of the tag. Example: beta.
configcat_webhook_createCreate a webhook that ConfigCat calls when a flag value changes in a config and environment.WriteCreate Webhook
Create a webhook that ConfigCat calls when a flag value changes in a config and environment. Returns the new webhook with its webhookId. Use post with content to send a message body.
Inputs
config_idstringrequired- Config ID. Get it from configcat_configs_list. Example: 08d86d63-2726-47cd-8bfc-59608ecb91e2.
environment_idstringrequired- Environment ID. Get it from configcat_environments_list. Example: 08d86d63-272c-4355-8027-4b52787bc1bd.
urlstringrequired- URL ConfigCat calls when a value in this config and environment changes. Example: https://example.com/hooks/configcat.
contentstring- Request body sent with post. Supports ConfigCat variables such as ##ConfigName##. Example: {"text": "##ConfigName## changed in ##EnvironmentName##"}
http_methodstring- HTTP method. Defaults to get. Example: post.one of
getpost web_hook_headersarray- Extra headers, each with key, value and isSecure. Example: [{"key": "X-Token", "value": "abc", "isSecure": true}]
configcat_webhook_replaceReplace a webhook's URL, method, body and headers.WriteReplace Webhook
Replace a webhook's URL, method, body and headers. Anything you leave out is cleared. Returns the updated webhook. Send every field you want to keep.
- Idempotent
Inputs
urlstringrequired- URL ConfigCat calls when a value in this config and environment changes. Example: https://example.com/hooks/configcat.
webhook_idintegerrequired- Numeric webhook ID from configcat_webhooks_list. Example: 77.
contentstring- Request body sent with post. Supports ConfigCat variables such as ##ConfigName##. Example: {"text": "##ConfigName## changed in ##EnvironmentName##"}
http_methodstring- HTTP method. Defaults to get. Example: post.one of
getpost web_hook_headersarray- Extra headers, each with key, value and isSecure. Example: [{"key": "X-Token", "value": "abc", "isSecure": true}]
configcat_config_deleteDelete a config with all its flags.DestructiveDelete Config
Delete a config with all its flags. This cannot be undone. Returns no content on success. Use configcat_configs_list to find IDs.
- Idempotent
Inputs
config_idstringrequired- Config ID. Get it from configcat_configs_list. Example: 08d86d63-2726-47cd-8bfc-59608ecb91e2.
configcat_environment_deleteDelete an environment and every flag value in it.DestructiveDelete Environment
Delete an environment and every flag value in it. This cannot be undone. Returns no content on success. Use configcat_environments_list to find IDs.
- Idempotent
Inputs
environment_idstringrequired- Environment ID. Get it from configcat_environments_list. Example: 08d86d63-272c-4355-8027-4b52787bc1bd.
cleanup_audit_logsboolean- An optional flag which indicates whether the audit log records related to the environment should be deleted or not. Example: true.
configcat_flag_deleteDelete a feature flag or setting from every environment.DestructiveDelete Flag
Delete a feature flag or setting from every environment. This cannot be undone. Returns no content on success. Check configcat_flag_code_references_get first to see where it is used.
- Idempotent
Inputs
setting_idintegerrequired- Numeric ID of the feature flag or setting. Get it from configcat_flags_list. Example: 1234.
configcat_product_deleteDelete a product with all its configs, environments and flags.DestructiveDelete Product
Delete a product with all its configs, environments and flags. This cannot be undone. Returns no content on success. Use configcat_products_list to find IDs.
- Idempotent
Inputs
product_idstringrequired- Product ID. Get it from configcat_products_list. Example: 08d86d63-2721-4da6-8c06-584521d516bc.
configcat_segment_deleteDelete a user segment.DestructiveDelete Segment
Delete a user segment. Returns no content on success. A segment still used in targeting rules may not be deletable.
- Idempotent
Inputs
segment_idstringrequired- Segment ID from configcat_segments_list. Example: 08d9c4f0-1a2b-4c3d-8e4f-5a6b7c8d9e0f.
configcat_tag_deleteDelete a tag and remove it from all flags.DestructiveDelete Tag
Delete a tag and remove it from all flags. Returns no content on success. Use configcat_tags_list to find IDs.
- Idempotent
Inputs
tag_idintegerrequired- Numeric tag ID from configcat_tags_list. Example: 42.
configcat_webhook_deleteDelete a webhook.DestructiveDelete Webhook
Delete a webhook. Returns no content on success. Use configcat_webhooks_list to find IDs.
- Idempotent
Inputs
webhook_idintegerrequired- Numeric webhook ID from configcat_webhooks_list. Example: 77.
No tools match.