Your AI team, working in Unleash

Unleash is a feature management platform for creating, configuring, and governing feature flags across projects and environments.

Start your company

What your team can do in Unleash

297 tools to work with, connected with an API key.

[BETA] Create a signal endpoint

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Creates a new signal endpoint.

[BETA] Create a signal endpoint token for a specific signal endpoint

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Creates a new signal endpoint token for a specific signal endpoint, identified by its ID. The response may contain a one-time authentication token; store it securely and never log it.

[BETA] Create an action set

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Creates a new action set.

[BETA] Delete a signal endpoint

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Deletes an existing signal endpoint identified by its id.

[BETA] Delete a signal endpoint token

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Deletes an existing signal endpoint token identified by its id.

[BETA] Delete an action set

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Deletes an existing action set identified by its id.

[BETA] Disconnect all clients

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Disconnects all streaming clients.

[BETA] Get aggregated metered connections for a given time periodReads only

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Gets metered connections count for the selected period, either aggregated by day or by month.

[BETA] Get aggregated metered requests for a given time periodReads only

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Gets metered requests count for the selected period, either aggregated by day or by month.

[BETA] List action setsReads only

**[BETA]** Returns the action sets for a specified project. The API may change or be removed.

[BETA] List events for an action setReads only

**[BETA]** Returns one page of events for a specific action set in a project. The API may change or be removed; use the returned cursor to continue.

[BETA] List signal endpointsReads only

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Returns a list of all configured signal endpoints.

[BETA] List signalsReads only

**[BETA]** Returns one page of signals in the requested creation-date range. The API may change or be removed; pass next_cursor unchanged to continue the same query.

[BETA] List signals from a specific signal endpointReads only

**[BETA]** Returns one page of signals from a specific signal endpoint. The API may change or be removed; pass next_cursor unchanged to continue the same query.

[BETA] List tokens for a specific signal endpointReads only

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Returns a list of all configured signal endpoint tokens for a specific signal endpoint, identified by its id.

[BETA] Update a signal endpoint

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Updates an existing signal endpoint identified by its id.

[BETA] Update a signal endpoint token

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Updates an existing signal endpoint token identified by its id.

[BETA] Update an action set

**[BETA]** Update an action set in a project; the API may change or be removed. The enabled state defaults to true if omitted.

Add a feature dependency

Add a dependency to a parent feature. Each environment will resolve corresponding dependency independently.

Add a release plan

Adds a release plan to a specific feature flag and environment.

Add an environment to a project

Associate one existing environment with a project, optionally configure change requests, and optionally create the default activation strategy used when enabling feature flags in that project environment.

Add and remove tags across features

Add and remove the supplied tags on every listed feature in a project, creating added tags when needed. Both tags.addedTags and tags.removedTags are required and may be empty; additions are applied before removals.

Add environments to a project

Sequentially associate multiple environments with a project, rejecting duplicate names and associations marked visible in preflight. On failure, this non-atomic workflow attempts to delete acknowledged additions in reverse order and reports progress, cleanup failures, and possible partial state, including unknown failed-item outcomes.

Add feature dependencies

Add multiple parent dependencies to one child feature flag in order. The action rejects existing dependencies before mutation and compensates a failed batch in reverse order by deleting additions made during this run. This non-atomic compensating workflow can execute deletions; inspect complete, partial_state, failed_item_outcome, and rollback_failures. A definitive 4xx rejects the failed item, while a 5xx or transport failure leaves its outcome unknown because Unleash may have committed it.

Add Feature Strategy

Add one activation strategy configuration to a feature flag in an environment.

Approve a user access request

Approves a pending user access request, creating a new user with the specified role.

Archive a release template

Archives a global release template or a template scoped to one project. The project branch is a beta API.

Archive Feature

Archive a feature flag in a project. The feature can be revived in Unleash, but revival is not performed by this action.

Archives a list of features

This endpoint archives the specified features. Any features that are already archived or that don't exist are ignored. All existing features (whether already archived or not) that are provided must belong to the specified project.

Batch evaluate an Unleash context against a set of environments and projectsReads only

Use the provided `context`, `environments`, and `projects` to evaluate toggles on this Unleash instance. You can use comma-separated values to provide multiple values to each context field. Returns a combinatorial list of all toggles that match the parameters and what they evaluate to. The response also contains the input parameters that were provided.

Change password for a user

Immediately replaces a user's password as an administrator. Treat credentials as secrets and never log them.

Change specific properties of a strategy

Change specific properties of a strategy configuration in a feature flag.

Change your own password

Immediately replaces the connected user's password after verifying the old password and confirmation. Treat credentials as secrets and never log them.

Check dependencies existReads only

Check whether dependencies exist for a specified Unleash project.

Clone a feature flag

Create a copy of the specified feature flag in its project, with a new name and an optional group ID setting.

Clones an environment

Given an existing environment name and a set of options, this will create a copy of that environment

Configure project access

Configure project access for groups and single users. The provided users and groups will be given the roles specified in the payload.

Create (overwrite) variants for a feature flag in multiple environments

Replace the feature flag's complete variant list in every environment named by environments. The same list is written to all targets; an empty variants list removes all variants from every named environment.

Create (overwrite) variants for a feature in an environment

Replace the feature flag's complete variant list in one environment. An empty variants list removes all variants. If variants are supplied, at least one must use variable weight; fixed weights must total less than 1000, and Unleash distributes the remainder among variable-weight variants.

Create a banner

Creates a new banner.

Create a feature link

Create a new link for a feature.

Create a new addon

Create an external event integration. If enabled is true, Unleash starts sending the selected project and environment events to the configured external provider; create it disabled to configure delivery without starting it.

Create a new group

Creates an Enterprise user group for role-based access control, with optional SSO mappings, predefined root role, and initial user membership.

Create a new personal access token (PAT) for the current user

Creates a new [personal access token](https://docs.getunleash.io/concepts/api-tokens-and-client-keys#personal-access-tokens (PAT) belonging to the current user. The response may contain secret material that is shown only when issued; store it securely and never log it.

Create a new role

Create a new custom role for Role-Based Access Control.

Create a new tag

Create a new tag with the specified data.

Create a new user

Creates a new user with the given root role. By default, Unleash sends the user an irreversible welcome email containing a login link; set send_email=false to suppress it.

Create a project API token

Create an API token scoped to the specified project. The response can reveal the token secret only when issued; store it securely and never log it.

Create a public signup token

Lets administrators create a invite link to share with colleagues. People that join using the public invite are assigned the `Viewer` role. The response may contain secret material that is shown only when issued; store it securely and never log it.

Create a release template

Creates and returns a release template with its name, optional nullable description, and optional milestone configuration. Project scope uses a beta API.

Create a service account

Creates a new service account.

Create a strategy

Creates a custom strategy type based on the supplied data.

Create a tag type

Create a new tag type.

Create a token for a service account

Creates a new token for the service account identified by the id. The response may contain secret material that is shown only when issued; store it securely and never log it.

Create an application to connect reported metrics

Create an application record with its loaded activation strategies and optional URL, color, and icon metadata. This operation does not report an SDK name or version.

Create API token

Create a backend, frontend, or deprecated client API token with optional project, environment, and expiry restrictions. The response can reveal the token secret only when issued; store it securely and never log it.

Create Context Field

Create a root context field or a project context field. The project scope uses Unleash's beta project-context API.

Create Feature

Create a feature flag in a project without enabling it in any environment.

Create or update a milestone progression

Creates or updates a milestone progression by source milestone ID. If a progression with the given source milestone exists, it will be updated; otherwise, a new one will be created.

Create or update safeguard

Create or update a metric-threshold safeguard for a feature environment or a release plan. For a release-plan safeguard, provide the plan ID; omit it for a feature-environment safeguard. Returns the saved safeguard and its ID for DELETE_SAFEGUARD.

Create project

Create a new [Unleash project](https://docs.getunleash.io/concepts/projects).

Create Segment

Create a reusable segment from a name and complete constraint list.

Create/Add change to a change request

Add one or more typed changes to the caller's existing draft change request for the project environment, or create a draft when none exists.

Creates a new environment

Uses the details provided in the payload to create a new environment

Delete a banner

Deletes an existing banner identified by its id.

Delete a custom role

Delete a custom role by id. You cannot delete built-in roles or roles that are in use. This operation changes access or identity state and may be destructive or immediately disruptive.

Delete a feature dependency

Remove one named parent feature dependency from a child feature flag.

Delete a feature link

Delete a feature link by id.

Delete a milestone progression

Deletes an existing milestone progression by source milestone ID.

Delete a personal access token (PAT) for the current user

Permanently and immediately revoke one personal access token belonging to the current user by its numeric PAT ID. The credential stops authenticating at once. Composio cannot compare its opaque connection credential with provider token IDs, so the caller must independently verify that this PAT does not back the current Composio connection and explicitly confirm that check.

Delete a release plan

Delete a release plan from a specific feature flag and environment.

Delete a release template

Permanently deletes a global release template or a template scoped to one project. The project branch is a beta API.

Delete a service account

Deletes an existing service account identified by its id. This operation changes access or identity state and may be destructive or immediately disruptive.

Delete a single group

Delete a single user group by group id. This operation changes access or identity state and may be destructive or immediately disruptive.

Delete a strategy

Deletes the specified strategy definition

Delete a tag

Delete a tag by type and value. When a tag is deleted all references to the tag are removed.

Delete a tag type

Deletes a tag type. If any features have tags of this type, those tags will be deleted.

Delete a token for a service account

Permanently and immediately revoke one service account token by service account ID and token ID. Workloads using that credential lose authentication immediately and cannot recover the deleted token. Composio cannot compare its opaque connection credential with provider token IDs, so the caller must independently verify that this token does not back the current Composio connection and explicitly confirm that check.

Delete a user

Deletes the user with the given userId. This operation changes access or identity state and may be destructive or immediately disruptive.

Delete all SCIM groups

Deletes all groups managed by SCIM. This operation changes access or identity state and may be destructive or immediately disruptive.

Delete all SCIM users

Deletes all users managed by SCIM. This operation changes access or identity state and may be destructive or immediately disruptive.

Delete an addon

Delete the addon specified by the ID in the request path.

Delete an application

Delete the specified application.

Delete an environment

Delete an environment identified by name.

Delete Context Field

Permanently delete a root or project context field without removing its existing use in strategy configuration. The project scope uses Unleash's beta project-context API.

Delete Context Field Legal Value

Permanently delete a legal value from a root or project context field without removing its existing use in constraints. The project scope uses Unleash's beta project-context API.

Delete feature dependencies

Remove all parent feature dependencies from one child feature flag.

Delete Feature Strategy

Permanently delete one activation strategy instance from a feature flag in an environment.

Delete impact metric configuration

Permanently delete one impact metric chart configuration by config_id from the instance-level collection or from one feature flag.

Delete project

Permanently delete the provided project. All feature flags in the project must be archived before you can delete it. This permanently deletes the project and its archived flags. It can not be undone.

Delete safeguard

Permanently delete one safeguard by safeguard_id from a feature environment or from one release plan. Set target to release_plan and provide plan_id for a release-plan safeguard; omit plan_id for feature_environment.

Delete Segment

Permanently delete a segment by numeric ID. Unleash rejects deletion while the segment is in use.

Deletes a change request by id

This endpoint will delete one change request if it matches the provided id.

Deletes a list of features

Permanently this endpoint deletes the specified features, that are in archive.

Deletes an archived feature

Permanently this endpoint deletes the specified feature if it is archived. If the feature is not archived, it is left unchanged.

Deletes inactive users

Deletes only the explicitly supplied IDs of users who have not logged in during the last 180 days. It does not delete every inactive user automatically. This operation changes access or identity state and may be destructive or immediately disruptive.

Discards a change from a change request by change id

This endpoint will discard one change from a change request if it matches the provided id.

Edits a single change in a change request

Replace one change in a change request. Unleash removes the selected change and inserts the typed replacement, so its old change ID becomes invalid; use the returned request's latest change ID for subsequent edits.

Enable or disable maintenance mode

Enable or disable maintenance mode for the entire Unleash instance. Enabling it makes the instance mostly read-only and blocks all users from changing configuration. The effect is reversible: disabling maintenance mode restores configuration writes without undoing existing configuration.

Evaluate an Unleash context against a change request previewReads only

Use the provided `context` to evaluate toggles on this Unleash instance with a change request applied in preview mode. You can use comma-separated values to provide multiple values to each context field. Returns a combinatorial list of all toggles that match the parameters and what they evaluate to.

Export feature flags from an environmentReads only

Export feature flag configuration from one environment, selecting by exactly one of feature names, tag, or project. The result contains feature definitions and strategies plus applicable environment configuration, context fields, tags, tag types, segments, dependencies, and links. Results are JSON; download_file=true delivers that JSON as a downloadable file, not CSV.

Generate user password-reset URL

Generates and returns a password-reset URL for the user identified by email; it does not change the password. Treat the returned URL as secret material: store it securely and never log it.

Generates a new SCIM API token

Generates a new SCIM API token. Previously generated tokens will be invalidated. The response may contain secret material that is shown only when issued; store it securely and never log it.

Get a list of all flag creators for a projectReads only

This endpoint returns every user who created a flag in the project.

Get a list of all users that have created eventsReads only

Returns a list of all users that have created events in the system.

Get a list of groupsReads only

Get a list of user groups for Role-Based Access Control.

Get a list of rolesReads only

Get a list of project, root and custom roles for Role-Based Access Control.

Get a release templateReads only

Returns a global release template or a template scoped to one project. The project branch is a beta API.

Get a single groupReads only

Get a single user group by group id.

Get a single roleReads only

Get a single role by role id.

Get a specific addonReads only

Retrieve information about the addon whose ID matches the ID in the request URL.

Get a strategy configurationReads only

Get a strategy configuration for an environment in a feature flag.

Get a strategy definitionReads only

Retrieves the definition of the strategy specified in the URL

Get a tag by type and valueReads only

Get a tag by type and value. Can be used to check whether a given tag already exists in Unleash or not.

Get a tag typeReads only

Get a tag type by name.

Get aggregated traffic data for a given time periodReads only

Gets traffic usage data for the selected period, either aggregated by day or by month.

Get all addons and providersReads only

Retrieve all addons and providers that are defined on this Unleash instance.

Get all applicationsReads only

Returns one page of applications across the Unleash instance or for one project, with a route-bound cursor for continuation.

Get all bannersReads only

Returns a list of all configured banners.

Get all environmentsReads only

Retrieves all environments that exist in this Unleash instance.

Get all feature typesReads only

Retrieves all feature types that exist in this Unleash instance, along with their descriptions and lifetimes.

Get all features lifecycle stage countReads only

Return instance-wide feature flag counts grouped into the initial, pre-live, live, completed, and archived lifecycle stages. Each value is the number of feature flags currently in that stage.

Get all login eventsReads only

Return all login and logout events in the Unleash system as structured JSON, including success, client, and failure details when available.

Get all pending user access requestsReads only

Returns a list of all pending user access requests.

Get all personal access tokens (PATs) for the current userReads only

Returns all of the [personal access tokens](https://docs.getunleash.io/concepts/api-tokens-and-client-keys#personal-access-tokens) (PATs) belonging to the current user. Treat token or credential values as secrets and never log them.

Get all tag typesReads only

Get a list of all available tag types.

Get all tags for a featureReads only

Retrieves all the tags for a feature name. If the feature does not exist it returns an empty list.

Get all users and [root roles](https://docs.getunleash.io/concepts/rbac#predefined-roles)Reads only

Will return all users and all available root roles for the Unleash instance.

Get an overview of a projectReads only

This endpoint returns an overview of the specified projects stats, project health, number of members, which environments are configured, and the features types in the project.

Get api tokens for projectReads only

Returns the project-specific [API tokens](https://docs.getunleash.io/concepts/api-tokens-and-client-keys) that have been created for this project.

Get application dataReads only

Returns data about the specified application (`appName`). The data contains information on the name of the application, sdkVersion (which sdk reported these metrics, typically `unleash-client-node:3.4.1` or `unleash-client-java:7.1.0`), as well as data about how to display this application in a list.

Get application environment instances (Last 24h)Reads only

Returns an overview of the instances for the given `appName` and `environment` that have received traffic in the last 24 hours.

Get application overviewReads only

Return an application's projects, feature count, environment and SDK activity, and missing-feature, outdated-SDK, or missing-strategy issues.

Get basic user and group informationReads only

Get a subset of user and group information eligible even for non-admin users.

Get Context FieldReads only

Get one root or project context field by name. The project scope uses Unleash's beta project-context API.

Get Detailed InvoicesReads only

Return detailed Enterprise billing data: plan price and currency plus invoice dates, totals, tax, status, invoice links, primary package or seat line items, and usage, consumption, or overage line items.

Get FeatureReads only

Get one feature flag with its metadata, lifecycle, dependencies, tags, environment enablement, and strategy configurations.

Get Feature EnvironmentReads only

Get a feature flag's enablement state, complete strategy configurations, variants, release plans, and safeguards in one environment.

Get feature flag strategiesReads only

Get strategies defined for a feature flag in the specified environment.

Get feature lifecycleReads only

Return the selected feature flag's lifecycle history, including each recorded stage, when the feature entered it, and any detailed stage status. Use this instead of the feature-detail read when the full sequence of lifecycle transitions is needed rather than only the current lifecycle state.

Get feature metricsReads only

Get usage metrics for a specific feature for the last 48 hours, grouped by hour

Get instance informationReads only

Gets high level information about the usage of this Unleash instance, including user, project, and flag information.

Get licensed user statisticsReads only

Return the available seat count, current license usage, and monthly licensed-user count history for this Unleash instance.

Get lifecycle trendsReads only

Gets lifecycle trends information showing feature flag progression across development, production, and cleanup stages.

Get maintenance mode statusReads only

Tells you whether maintenance mode is enabled or disabled

Get OIDC auth settingsReads only

Returns the current OIDC authentication settings, excluding the client secret. The response includes an indicator based on whether a secret was present in the provider response.

Get Plausible analytics dataReads only

Fetches analytics data from Plausible API for favorite events over the last 7 days.

Get project statusReads only

This endpoint returns information on the status the project, including activities, health, resources, and aggregated flag lifecycle data.

Get project-role mappingsReads only

For the provided role, retrieves a list of projects that use this role. For each project it also contains information about how the role used in that project, such as how many users, groups, or service accounts that use the role.

Get remote MCP server settingsReads only

Returns the current settings for the remote MCP server.

Get SAML auth settingsReads only

Returns the current settings for SAML authentication.

Get scheduled change requests matching a queryReads only

List scheduled change requests that touch the supplied feature flag name or activation strategy ID. At least one criterion is required; when both are supplied, Unleash returns requests matching either criterion.

Get SCIM settingsReads only

Returns the current settings for SCIM provisioning.

Get SegmentReads only

Get one reusable segment and its complete constraint definition by numeric ID.

Get Simple auth settingsReads only

Is simple authentication (username/password) enabled for this server.

Get strategies that use a context fieldReads only

Retrieves strategies using a root context field or a project context field. A missing context field returns an empty strategy list; the project branch is a beta API.

Get telemetry settingsReads only

Provides the configured settings for [telemetry information collection](https://docs.getunleash.io/privacy-and-compliance/data-privacy)

Get the environment with `name`Reads only

Retrieves the environment with `name` if it exists in this Unleash instance

Get the external impact-metrics sourceReads only

Returns the current configuration of the external impact-metrics source (any Prometheus-compatible endpoint).

Get the number of change requests you can do something withReads only

Returns the number of change requests in this project that your user can move into the next stage by approving or applying them.

Get total count of admin accountsReads only

Get a total count of admins with password, without password and admin service accounts.

Get userReads only

Will return a single user by id.

Get users and groups in projectReads only

Get all groups, users and their roles, and available roles for the given project.

Get variants for a feature in an environmentReads only

Returns the variants for a feature in a specific environment. If the feature has no variants it will return an empty array of variants

Get your own user detailsReads only

Detailed information about the current user, user permissions and user feedback.

Get your own user profileReads only

Detailed information about the current user root role and project membership.

Gets access overviewReads only

Gets an overview of what access all users have to all projects and groups.

Gets usage dataReads only

Gets usage data per app/endpoint from a prometheus compatible metrics endpoint

Import feature flags

Import exported JSON feature flag configuration into the target project and environment. This can create or replace feature definitions, strategies, variants, tags, dependencies, context-field references, and environment state; when change requests are enabled, Unleash creates a draft change request instead of applying changes immediately.

Instance usage statisticsReads only

Provides statistics about various features of Unleash to allow for reporting of usage for self-hosted customers. The response contains data such as the number of users, groups, features, strategies, versions, etc.

Instance usage statisticsReads only

Download a CSV file of self-hosted instance usage statistics, including counts and version data for users, groups, feature flags, and strategies.

Last hour of usage and a list of applications that have reported seeing this feature flagReads only

Separate counts for yes (enabled), no (disabled), as well as how many times each variant was selected during the last hour

List all tagsReads only

List all tags available in Unleash.

List all tags of a given typeReads only

List all tags of a given type. If the tag type does not exist it returns an empty list.

List all tokens for a service accountReads only

Returns the list of all tokens for a service account identified by the id. Treat token or credential values as secrets and never log them.

List API tokensReads only

Retrieves all API tokens that exist in the Unleash instance. Treat token or credential values as secrets and never log them.

List API tokens by nameReads only

Retrieves all API tokens that match a given token name. Because token names are not unique, this endpoint will always return a list. If no tokens with the provided name exist, the list will be empty. Otherwise, it will contain all the tokens with the given name. Treat token or credential values as secrets and never log them.

List available change request reviewersReads only

List users who are available to review or approve a change request in the specified project environment.

List available impact metricsReads only

Returns all available impact metrics and their metadata.

List available permissionsReads only

Returns a list of available permissions.

List change requests for a projectReads only

This endpoint will retrieve all change requests regardless of status for a given project. There's an upper limit of last 300 change requests ordered by creation date.

List Context FieldsReads only

List configured root context fields or project context fields. The project scope uses Unleash's beta project-context API.

List FeaturesReads only

List every feature flag in one project with its high-level state in each environment.

List impact metric configurationsReads only

List impact metric chart configurations for either the Unleash instance (not associated with a feature flag) or one feature flag.

List inactive usersReads only

Gets all inactive users. An inactive user is a user that has not logged in in the last 180 days.

List integration events for a specific integration configurationReads only

Returns one page of integration events for a specific integration configuration, identified by its ID. Use the returned cursor to continue the same query when more events may be available.

List invoicesReads only

Return Enterprise invoice summaries for billing review, including formatted amount due, paid state, current status, optional due date, and links to view or download each invoice as PDF. Use GET_DETAILED_INVOICES when plan pricing and line-item breakdowns are needed.

List notificationsReads only

A user may get relevant notifications from the projects they are a member of

List outdated SDKsReads only

Lists outdated SDK versions and the applications using them across the instance or in one project.

List parent feature variantsReads only

List available parent variants across all strategy variants and feature environment variants.

List parent optionsReads only

List available parents who have no transitive dependencies.

List pending change requests referencing a featureReads only

This endpoint will retrieve all pending change requests (change requests with a status of Draft | In review | Approved) referencing the given feature flag name.

List Project EnvironmentsReads only

List environments available to a project with project-specific visibility and enabled-toggle counts.

List ProjectsReads only

List projects available to the connected Admin API principal, optionally including archived projects.

List public signup tokensReads only

Retrieves all existing public signup tokens. Treat token or credential values as secrets and never log them.

List release plansReads only

Returns a list of all release plans for a specific feature flag and environment.

List release templatesReads only

Lists global release templates or templates for one project. The project branch is a beta API; set include_global to include global templates with project results.

List requested change request reviewersReads only

Get the users currently requested to review a change request. These are requested reviewers, not users who have already approved it.

List roles for the currently logged-in userReads only

Get roles assigned to the currently logged-in user for a specified project, including roles assigned directly and through group memberships.

List SegmentsReads only

List all reusable segments in the Unleash instance with their constraints and usage counts.

List service accountsReads only

Returns the list of all service accounts.

List strategies that reference a segmentReads only

Retrieve all strategies that reference the specified segment.

List strategy segmentsReads only

Retrieve all segments that are referenced by the specified strategy. Returns an empty list of segments if the strategy ID doesn't exist.

List Strategy TypesReads only

List predefined and custom strategy types available for feature configuration.

List unknown flagsReads only

Returns a list of unknown flag reports from the last 24 hours, if any. Maximum of 1000.

Mark features as stale / not stale

This endpoint marks the provided list of features as either [stale](https://docs.getunleash.io/concepts/technical-debt#stale-and-potentially-stale-flags) or not stale depending on the request body you send. Any provided features that don't exist are ignored.

Mark notifications as read

Allow to select which notifications were read and saving a read date

Modify a feature flag

Change specific properties of a feature flag.

Move feature to project

Moves the specified feature to the new project in the request schema. Requires you to have permissions to move the feature flag in both projects. Features that are included in any active change requests can not be moved.

Patch a feature's variants in an environment

Apply RFC 6902 JSON patches to a feature flag's variants in a specified environment.

Query impact metrics time series dataReads only

Queries an impact metric source for time series data based on the provided metric name, time range, and aggregation mode.

Reads the Unleash licenseReads only

Reads the Unleash license. Only available for self-hosted Enterprise customers.

Register a new impact metric

Registers a new impact metric by pushing 0-values.

Reject a user access request

Rejects an existing user access request identified by its id. This operation changes access or identity state and may be destructive or immediately disruptive.

Remove an environment from a project

This endpoint removes the specified environment from the project.

Remove project access for a group

Removes project access for a group by removing all of its roles for the project.

Remove project access for a user

Removes project access for a user by removing all of its roles for the project.

Resume paused milestone progressions

Resumes all paused milestone progressions for a release plan

Retrieves change request configuration for a projectReads only

Given a projectId, this endpoint will retrieve change request configuration for the project

Retrieves number of project change requests in each stateReads only

This endpoint will retrieve the number of project change requests that are: approved, applied, rejected, scheduled or awaiting review

Retrieves one change request by idReads only

This endpoint will retrieve one change request if it matches the provided id.

Retrieves pending change requests in configured environmentsReads only

This endpoint will retrieve the pending change requests in the configured environments for the project, for the current user performing the request.

Returns the list of permissions for the service accountReads only

Gets a list of permissions for a service account. Project and environment can be specified.

Revives a feature

This endpoint revives the specified feature from archive.

Revives a list of features

Revives the specified feature flags in a project.

Save impact metric configuration

Create or update an instance-level or feature-level impact metric chart configuration. Omit id to create one; provide its id to update it.

Search change requestsReads only

Search and filter change requests by creator and approver.

Search FeaturesReads only

Search and filter feature flags across projects. Returns one offset-paginated page; pass cursor unchanged to continue the same search.

Search for eventsReads only

Allows searching for events that match the query parameter criteria.

Search usersReads only

It will preform a simple search based on name and email matching the given query. Requires minimum 2 characters.

Set a new Unleash license

Set a new Unleash license. Only available for self-hosted Enterprise customers.

Set Action Set State

Enable or disable one project action set.

Set Banner State

Enable or disable an instance banner.

Set change request reviewers

Replace the requested reviewers for a change request with the complete supplied user-ID list. Omitted existing IDs are removed, an empty list removes every reviewer, and at most 10 reviewers are allowed.

Set Email Subscription

Subscribe or unsubscribe the current principal from an email notification category.

Set Environment State

Enable or disable an environment across the Unleash instance.

Set environment-default strategy

Sets a default strategy for this environment. Unleash will use this strategy by default when enabling a feature flag. Use the wild card "*" for `:environment` to add to all environments.

Set Feature Environment State

Enable or disable one feature flag in one environment.

Set Feature Favorite

Add or remove one feature flag from the current principal's favorites.

Set Feature Lifecycle Completion

Mark a feature lifecycle as completed with a kept or discarded outcome, or mark it incomplete again.

Set Features Environment State

Enable or disable the supplied feature flags in one project environment.

Set OIDC settings

Configure or partially update OpenID Connect login, user auto-creation, roles, group syncing, PKCE, and scopes. Disabling OIDC or replacing invalid credentials can immediately prevent users from signing in; treat the client secret as sensitive.

Set Project Archived

Archive or revive one project; archiving requires all project flags to be archived first.

Set Project Favorite

Add or remove one project from the current principal's favorites.

Set SCIM settings

Sets new settings for SCIM provisioning. This operation changes access or identity state and may be destructive or immediately disruptive.

Set Signal Endpoint State

Enable or disable one outbound signal endpoint.

Set Strategy Deprecated

Deprecate or reactivate one custom strategy type.

Set strategy sort order

Replace the sort order for the complete supplied list of strategy instances in this feature environment.

Set the external impact-metrics source

Updates the configuration of the external impact-metrics source (any Prometheus-compatible endpoint).

Set users and groups to roles in the current project

Replaces the complete project access configuration with the supplied role assignments. Existing assignments omitted from roles are removed; an empty roles list removes all project access assignments. Within a role, an empty users or groups list removes every assignment of that type for that role.

Sets allowed CORS origins

Sets Cross-Origin Resource Sharing headers for Frontend SDK API.

Sets roles for group

Replace all project roles assigned to a group. Pass the complete desired role ID list; an empty list removes all of the group's roles and its project access.

Sets roles for user

Replace all project roles assigned directly to a user. Pass the complete desired role ID list; an empty list removes all direct roles and therefore the user's direct project access.

Start a release plan milestone

Starts a release plan milestone, advancing a one-way release transition that may apply the milestone's rollout configuration and cannot simply be undone.

This endpoint will add a comment to a change request

This endpoint will add a comment to a change request for the user making the request.

This endpoint will update the custom title of a change request

Replace a change request's custom title. Pass an empty title to clear it and restore display of Unleash's generated default, such as Change Request #1.

This endpoint will update the state of a change request

Move a change request to Draft, In review, Approved, Cancelled, or Applied when Unleash's transition rules allow it. Approval requires at least one change and enough approvals. Applied and Cancelled are terminal and cannot be changed afterward; editing an Approved request returns it to In review and clears its approvals.

Toggle remote MCP server settings

Toggles the remote MCP server for this Unleash instance.

Update a banner

Updates an existing banner identified by its id.

Update a feature link

Update an existing feature link.

Update a group

Update existing user group by group id. It overrides previous group details.

Update a milestone strategy

Update a milestone strategy configuration for a feature flag in the specified environment.

Update a release template

Updates a release template's name, description, and replacement milestone configuration. Unleash will delete and rebuild existing milestones from the supplied `milestones` body field, so this cannot simply be undone. Project scope uses a beta API.

Update a role

Update a custom role by its role ID. The provider requires the role name on every update; supplied permissions replace the role's assigned permission list.

Update a service account

Updates an existing service account identified by its id.

Update a strategy type

Update a custom strategy type's optional description and replace its complete parameter definition list. Parameters are always required by Unleash; pass an empty list to remove all parameter definitions.

Update a tag type

Update the configuration for the specified tag type.

Update a user

Update a user's email, name, or root role by user ID. Only explicitly specified non-null fields are sent.

Update an addon

Replace an external event integration configuration. Provide the provider, description, enabled state, complete event filter, complete project filter, complete environment filter, and all provider parameters required for that provider. Unleash masks stored webhook URLs and other secrets, so callers must resend the real URL or credential on every update. Changing destination configuration or filters redirects future deliveries; setting enabled to true starts delivery and false stops it. Passing null for description clears it to an empty string; empty project or environment lists select all.

Update Context Field

Update supplied settings of a root or project context field. The project scope uses Unleash's beta project-context API.

Update environment sort orders

Updates sort orders for the named environments. Environments not specified are unaffected.

Update Feature

Update supplied description, type, stale or archive state, or impression-data setting on an existing feature flag. Setting archived to true moves the flag into the archive; omitted fields remain unchanged.

Update Feature Strategy

Replace supplied configuration fields on one feature strategy instance.

Update feature tags

Sync one or many feature tags with PUT, add one tag with POST, or remove one tag with DELETE. Sync requires both added_tags and removed_tags, applies additions before removals, and accepts an empty list for either effect.

Update feature type lifetime

Updates the lifetime configuration for the specified [feature flag type](https://docs.getunleash.io/concepts/feature-flags#feature-flag-types). The expected lifetime is an integer representing the number of days before Unleash marks a feature flag of that type as potentially stale. If set to `null` or `0`, then feature flags of that particular type will never be marked as potentially stale. When a feature flag type's expected lifetime is changed, this will also cause any feature flags of this type to be reevaluated for potential staleness.

Update project

Update a project's name and optionally its description, access mode, or default stickiness. The complete new name is always required; omitted optional fields remain unchanged.

Update project enterprise settings

Update project enterprise settings with new values. Any fields not provided are ignored.

Update SAML auth settings

Configure or partially update SAML login, certificates, user auto-creation, roles, and group syncing. Disabling SAML or replacing invalid identity-provider settings can immediately prevent users from signing in.

Update Segment

Update a segment by replacing its required name and complete constraint list plus optional metadata.

Update Simple auth settings

Enable or disable simple authentication (username/password). This operation changes access or identity state and may be destructive or immediately disruptive.

Update strategy segments

Sets the segments of the strategy specified to be exactly the ones passed in the payload. Any segments that were used by the strategy before will be removed if they are not in the provided list of segments.

Updates an environment by name

Given an environment by name updates the environment with the given payload. Note that `name`, `enabled` and `protected` cannot be changed by this API

Updates change request configuration for an environment in the project

Update change request configuration for a project environment, enabling or disabling it and optionally setting the required approvals. Unleash clamps 0 or values above 10 to the allowed range of 1–10; negative values are rejected by the tool.

Upsert Context Field Legal Value

Add a legal value to a root or project context field, or update its description when the value already exists. The project scope uses Unleash's beta project-context API.

Validate a feature flag nameReads only

Validates a feature flag name: checks whether the name is URL-friendly and whether a feature with the given name already exists. Returns 200 if the feature name is compliant and unused.

Validate a roleReads only

Check if the role matches schema and has a unique name.

Validate a tag typeReads only

Validates whether if the body of the request is a valid tag and whether the a tag type with that name already exists or not. If a tag type with the same name exists, this operation will return a 409 status code.

Validate an external impact-metrics source URLReads only

Tests an external impact-metrics source URL without persisting it. Returns discovered metric names on success or an error explaining a validation failure; request-level errors can also occur.

Validate constraintReads only

Validates a constraint definition. Checks whether the context field exists and whether the applied configuration is valid. Additional properties are not allowed on data objects that you send to this endpoint.

Validate Context Field NameReads only

Check whether a proposed name can be used for a root or project context field. Invalid names produce an Unleash validation error. The project scope uses Unleash's beta project-context API.

Validate feature import dataReads only

Validates a feature flag data set. Checks whether the data can be imported into the specified project and environment. The returned value is an object that contains errors, warnings, and permissions required to perform the import, as described in the [import documentation](https://docs.getunleash.io/concepts/import-export#import-feature-flags).

Validate password for a userReads only

Validate the password strength. Minimum 10 characters, uppercase letter, number, special character. Treat token or credential values as secrets and never log them.

Validate project IDReads only

Validate a project ID against Unleash's rules

Validates archive featuresReads only

Preview the consequences of archiving the named feature flags. Returns parent features that would leave unarchived child features orphaned and whether the archive would delete feature dependencies; it does not archive anything.

Validates if a segment name existsReads only

Checks whether a segment name is already in use.

Validates if an environment name existsReads only

Checks whether an environment name is already in use.

Validates the Unleash licenseReads only

Check the current Enterprise license and return whether it is valid, along with any provider status message and its info, warning, or error severity.

More in Developer tools

See them all β†’

Your company, run by an AI team

Start your company

BRAINER

Continue to B.R.A.I.N.E.R.

Continue with Google or your email.

or