Feature Flags
Create and update feature flags for your projects to control which behavior your application enables. You can inspect targeting segments and project settings, and manage the SDK keys used to access flags.
Create a flag.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project id or name |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | Yes | Request body for this tool. |
Create an SDK key.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project id or name |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | No | Request body for this tool. |
Get a flag.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project id or name |
flagIdOrSlug | string | Yes | The flag id or name |
ifMatch | string | No | ETag to match, can be used interchangeably with the if-match header |
withMetadata | boolean | No | Whether to include metadata in the response |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
Get a segment.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project id or name |
segmentIdOrSlug | string | Yes | The segment slug |
withMetadata | boolean | No | Whether to include metadata Default: false. |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
Get project flag settings.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project id or name |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
Get all SDK keys.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project id or name |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
List flags.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project id or name |
state | string | No | The state of the flags to retrieve. Defaults to active. Allowed values: "active", "archived". |
withMetadata | boolean | No | Deprecated. Whether to include creator metadata in each flag in the response. Resolve creator identity client-side (e.g. via the team members endpoint) instead; this parameter will be removed in a future release. Use GET /v1/projects/:id/feature-flags/flags/:flagIdOrSlug?withMetadata=true for single-flag lookups that need creator metadata. |
limit | integer | No | Maximum number of flags to return. When not set, all flags are returned. |
cursor | string | No | Pagination cursor to continue from. |
search | string | No | Search flags by their slug or description. Case-insensitive. |
tags | Array<string> | No | Filter flags by tag. Repeat the parameter for multiple tags (all must match). |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
List flags.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project id or name |
state | string | No | The state of the flags to retrieve. Defaults to active. Allowed values: "active", "archived". |
limit | integer | No | Maximum number of flags to return. Default: 25. |
cursor | string | No | Pagination cursor to continue from. |
search | string | No | Search flags by their slug or description. Case-insensitive. |
tags | Array<string> | No | Filter flags by tag. Repeat the parameter for multiple tags (all must match). |
createdBy | string | No | Filter flags by the id of the entity that created them (a user or team id). |
maintainerIds | Array<string> | No | Filter flags by maintainer user id. Repeat the parameter for multiple maintainers (any may match). |
includeMarketplaceFlags | boolean | No | Whether to include Marketplace experimentation items in the paginated response. Defaults to false. |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
Update a flag.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project id or name |
flagIdOrSlug | string | Yes | The flag id or name |
ifMatch | string | No | ETag to match, can be used interchangeably with the if-match header |
withMetadata | boolean | No | Whether to include metadata in the response |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | No | Request body for this tool. |
Update a segment.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project id or name |
segmentIdOrSlug | string | Yes | The segment slug |
withMetadata | boolean | No | Whether to include metadata Default: false. |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | No | Request body for this tool. |
Update project flag settings.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project id or name |
teamId | string | No | Team ID. |
slug | string | No | Team slug. |
requestBody | object | No | Request body for this tool. |
Was this helpful?