Unleash

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

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

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.

Sequentially associate multiple environments with one project after rejecting duplicates and existing associations. On the first failure, attempts to remove only additions acknowledged during this run in reverse order. This is a non-atomic compensating workflow that can execute deletions; the response reports forward progress, cleanup attempts, cleanup failures, and possible partial state. A definitive 4xx rejects the failed item, while a 5xx or transport failure leaves that item's outcome unknown because Unleash may have committed it.

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 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 a dependency to a parent feature. Each environment will resolve corresponding dependency independently.

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

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

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.

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

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

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.

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

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.

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

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.

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.

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

Check if any dependencies exist in this Unleash instance

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

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

Creates a copy of the specified feature flag. The copy can be created in any project.

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

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 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 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.

Creates a new banner.

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

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

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

Create a new link for a feature.

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

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 [Unleash project](https://docs.getunleash.io/concepts/projects).

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.

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.

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

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

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

Creates a new 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.

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Creates a new 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.

Creates a custom strategy type based on the supplied data.

Create a new tag with the specified data.

Create a new tag type.

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.

**[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.

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

Delete the application specified in the request URL. Returns 200 OK if the application was successfully deleted or if it didn't exist

Deletes an existing banner identified by its id.

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

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

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.

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 an environment identified by name.

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

Remove all parent feature dependencies from one child feature flag.

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