Configure project accessConfigure project access for groups and single users.
This endpoint will add a comment to a change requestThis endpoint will add a comment to a change request for the user making the request.
Set environment-default strategySets a default strategy for this environment.
Add environments to a projectSequentially associate multiple environments with one project after rejecting duplicates and existing associations.
Add an environment to a projectAssociate 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 feature dependenciesAdd multiple parent dependencies to one child feature flag in order.
Add a feature dependencyAdd a dependency to a parent feature.
Add Feature StrategyAdd one activation strategy configuration to a feature flag in an environment.
Add a release planAdds a release plan to a specific feature flag and environment.
Add and remove tags across featuresAdd and remove the supplied tags on every listed feature in a project, creating added tags when needed.
Approve a user access requestApproves a pending user access request, creating a new user with the specified role.
Archive FeatureArchive a feature flag in a project.
Archives a list of featuresThis endpoint archives the specified features.
Archive a release templateArchives a global release template or a template scoped to one project.
Create or update a milestone progressionCreates or updates a milestone progression by source milestone ID.
Change your own passwordImmediately replaces the connected user's password after verifying the old password and confirmation.
Move feature to projectMoves the specified feature to the new project in the request schema.
Create/Add change to a change requestAdd one or more typed changes to the caller's existing draft change request for the project environment, or create a draft when none exists.
Change password for a userImmediately replaces a user's password as an administrator.
Check dependencies existCheck if any dependencies exist in this Unleash instance
Validates the Unleash licenseCheck the current Enterprise license and return whether it is valid, along with any provider status message and its info, warning, or error severity.
Clones an environmentGiven an existing environment name and a set of options, this will create a copy of that environment
Clone a feature flagCreates a copy of the specified feature flag.
[BETA] Create an action set**[BETA]** This API is in beta state, which means it may change or be removed in the future.
Create a new addonCreate an external event integration.
Create API tokenCreate a backend, frontend, or deprecated client API token with optional project, environment, and expiry restrictions.
Create an application to connect reported metricsCreate an application record with its loaded activation strategies and optional URL, color, and icon metadata.
Create a bannerCreates a new banner.
Create Context FieldCreate a root context field or a project context field.
Creates a new environmentUses the details provided in the payload to create a new environment
Create FeatureCreate a feature flag in a project without enabling it in any environment.
Create a feature linkCreate a new link for a feature.
Create a new groupCreates 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 userCreates a new [personal access token](https://docs.
Create projectCreate a new [Unleash project](https://docs.
Create a project API tokenCreate an API token scoped to the specified project.
Create a public signup tokenLets administrators create a invite link to share with colleagues.
Create a release templateCreates and returns a release template with its name, optional nullable description, and optional milestone configuration.
Create a new roleCreate a new custom role for Role-Based Access Control.
Create SegmentCreate a reusable segment from a name and complete constraint list.
Create a service accountCreates a new service account.
Create a token for a service accountCreates a new token for the service account identified by the id.
[BETA] Create a signal endpoint**[BETA]** This API is in beta state, which means it may change or be removed in the future.
[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.
Create a strategyCreates a custom strategy type based on the supplied data.
Create a new tagCreate a new tag with the specified data.
Create a tag typeCreate a new tag type.
Create a new userCreates a new user with the given root role.
[BETA] Delete an action set**[BETA]** This API is in beta state, which means it may change or be removed in the future.
Delete an addonDelete the addon specified by the ID in the request path.
Delete an applicationDelete the application specified in the request URL.
Delete a bannerDeletes an existing banner identified by its id.
Discards a change from a change request by change idThis endpoint will discard one change from a change request if it matches the provided id.
Deletes a change request by idThis endpoint will delete one change request if it matches the provided id.
Delete Context FieldPermanently delete a root or project context field without removing its existing use in strategy configuration.
Delete Context Field Legal ValuePermanently delete a legal value from a root or project context field without removing its existing use in constraints.
Delete an environmentDelete an environment identified by name.
Deletes an archived featurePermanently this endpoint deletes the specified feature if it is archived.
Delete feature dependenciesRemove all parent feature dependencies from one child feature flag.
Delete a feature dependencyRemove one named parent feature dependency from a child feature flag.
Delete a feature linkDelete a feature link by id.
Deletes a list of featuresPermanently this endpoint deletes the specified features, that are in archive.
Delete Feature StrategyPermanently delete one activation strategy instance from a feature flag in an environment.
Delete a single groupDelete a single user group by group id.
Delete impact metric configurationPermanently delete one impact metric chart configuration by config_id from the instance-level collection or from one feature flag.
Deletes inactive usersDeletes only the explicitly supplied IDs of users who have not logged in during the last 180 days.
Delete a milestone progressionDeletes an existing milestone progression by source milestone ID.
Delete a personal access token (PAT) for the current userPermanently and immediately revoke one personal access token belonging to the current user by its numeric PAT ID.
Delete projectPermanently delete the provided project.
Delete a release planDelete a release plan from a specific feature flag and environment.
Delete a release templatePermanently deletes a global release template or a template scoped to one project.
Delete a custom roleDelete a custom role by id.
Delete safeguardPermanently delete one safeguard by safeguard_id from a feature environment or from one release plan.
Delete all SCIM groupsDeletes all groups managed by SCIM.
Delete all SCIM usersDeletes all users managed by SCIM.
Delete SegmentPermanently delete a segment by numeric ID.
Delete a service accountDeletes an existing service account identified by its id.
Delete a token for a service accountPermanently and immediately revoke one service account token by service account ID and token ID.
[BETA] Delete a signal endpoint**[BETA]** This API is in beta state, which means it may change or be removed in the future.
[BETA] Delete a signal endpoint token**[BETA]** This API is in beta state, which means it may change or be removed in the future.
Delete a strategyDeletes the specified strategy definition
Delete a tagDelete a tag by type and value.
Delete a tag typeDeletes a tag type.
Delete a userDeletes the user with the given userId.
[BETA] Disconnect all clients**[BETA]** This API is in beta state, which means it may change or be removed in the future.
Export feature flags from an environmentExport feature flag configuration from one environment, selecting by exactly one of feature names, tag, or project.
Generates a new SCIM API tokenGenerates a new SCIM API token.
Gets access overviewGets an overview of what access all users have to all projects and groups.
Get the number of change requests you can do something withReturns the number of change requests in this project that your user can move into the next stage by approving or applying them.
Get a specific addonRetrieve information about the addon whose ID matches the ID in the request URL.
Get total count of admin accountsGet a total count of admins with password, without password and admin service accounts.
Batch evaluate an Unleash context against a set of environments and projectsUse the provided `context`, `environments`, and `projects` to evaluate toggles on this Unleash instance.
Get application dataReturns data about the specified application (`appName`).
Get application environment instances (Last 24h)Returns an overview of the instances for the given `appName` and `environment` that have received traffic in the last 24 hours.
Get application overviewReturn an application's projects, feature count, environment and SDK activity, and missing-feature, outdated-SDK, or missing-strategy issues.
Get basic user and group informationGet a subset of user and group information eligible even for non-admin users.
Retrieves one change request by idThis endpoint will retrieve one change request if it matches the provided id.
Evaluate an Unleash context against a change request previewUse the provided `context` to evaluate toggles on this Unleash instance with a change request applied in preview mode.
Retrieves number of project change requests in each stateThis endpoint will retrieve the number of project change requests that are: approved, applied, rejected, scheduled or awaiting review
[BETA] Get aggregated metered connections for a given time period**[BETA]** This API is in beta state, which means it may change or be removed in the future.
Get Context FieldGet one root or project context field by name.
Get Detailed InvoicesReturn 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 the environment with `name`Retrieves the environment with `name` if it exists in this Unleash instance
Get variants for a feature in an environmentReturns the variants for a feature in a specific environment.
Get the external impact-metrics sourceReturns the current configuration of the external impact-metrics source (any Prometheus-compatible endpoint).
Get FeatureGet one feature flag with its metadata, lifecycle, dependencies, tags, environment enablement, and strategy configurations.
Get Feature EnvironmentGet a feature flag's enablement state, complete strategy configurations, variants, release plans, and safeguards in one environment.
Get feature lifecycleReturn the selected feature flag's lifecycle history, including each recorded stage, when the feature entered it, and any detailed stage status.
Get feature flag strategiesGet strategies defined for a feature flag in the specified environment.
Get a strategy configurationGet a strategy configuration for an environment in a feature flag.
Last hour of usage and a list of applications that have reported seeing this feature flagSeparate counts for yes (enabled), no (disabled), as well as how many times each variant was selected during the last hour
Get a single groupGet a single user group by group id.
Instance usage statisticsProvides statistics about various features of Unleash to allow for reporting of usage for self-hosted customers.
Instance usage statisticsDownload a CSV file of self-hosted instance usage statistics, including counts and version data for users, groups, feature flags, and strategies.
Get instance informationGets high level information about the usage of this Unleash instance, including user, project, and flag information.
Get licensed user statisticsReturn the available seat count, current license usage, and monthly licensed-user count history for this Unleash instance.
Get lifecycle trendsGets lifecycle trends information showing feature flag progression across development, production, and cleanup stages.
Get maintenance mode statusTells you whether maintenance mode is enabled or disabled
Get your own user detailsDetailed information about the current user, user permissions and user feedback.
Get OIDC auth settingsReturns the current settings for OIDC Authentication.
Retrieves pending change requests in configured environmentsThis endpoint will retrieve the pending change requests in the configured environments for the project, for the current user performing the request.
Get Plausible analytics dataFetches analytics data from Plausible API for favorite events over the last 7 days.
Get your own user profileDetailed information about the current user root role and project membership.
Get users and groups in projectGet all groups, users and their roles, and available roles for the given project.
Get api tokens for projectReturns the project-specific [API tokens](https://docs.
Retrieves change request configuration for a projectGiven a projectId, this endpoint will retrieve change request configuration for the project
Get an overview of a projectThis 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 project statusThis endpoint returns information on the status the project, including activities, health, resources, and aggregated flag lifecycle data.
Get feature metricsGet usage metrics for a specific feature for the last 48 hours, grouped by hour
Get a release templateReturns a global release template or a template scoped to one project.
Get remote MCP server settingsReturns the current settings for the remote MCP server.
[BETA] Get aggregated metered requests for a given time period**[BETA]** This API is in beta state, which means it may change or be removed in the future.
Gets usage dataGets usage data per app/endpoint from a prometheus compatible metrics endpoint
Get a single roleGet a single role by role id.
Get project-role mappingsFor the provided role, retrieves a list of projects that use this role.
Get SAML auth settingsReturns the current settings for SAML authentication.
Get scheduled change requests matching a queryList scheduled change requests that touch the supplied feature flag name or activation strategy ID.
Get SCIM settingsReturns the current settings for SCIM provisioning.
Get SegmentGet one reusable segment and its complete constraint definition by numeric ID.
Returns the list of permissions for the service accountGets a list of permissions for a service account.
Get Simple auth settingsIs simple authentication (username/password) enabled for this server.
Get strategies that use a context fieldRetrieves strategies using a root context field or a project context field.
Get a strategy definitionRetrieves the definition of the strategy specified in the URL
Get a tag by type and valueGet a tag by type and value.
Get a tag typeGet a tag type by name.
Get telemetry settingsProvides the configured settings for [telemetry information collection](https://docs.
Get aggregated traffic data for a given time periodGets traffic usage data for the selected period, either aggregated by day or by month.
Get userWill return a single user by id.
Import feature flagsImport exported JSON feature flag configuration into the target project and environment.
[BETA] List events for an action set**[BETA]** This API is in beta state, which means it may change or be removed in the future.
[BETA] List action sets**[BETA]** This API is in beta state, which means it may change or be removed in the future.
Get all addons and providersRetrieve all addons and providers that are defined on this Unleash instance.
Get all environmentsRetrieves all environments that exist in this Unleash instance.
Get all feature typesRetrieves all feature types that exist in this Unleash instance, along with their descriptions and lifetimes.
List API tokensRetrieves all API tokens that exist in the Unleash instance.
List API tokens by nameRetrieves all API tokens that match a given token name.
Get all applicationsReturns one page of applications across the Unleash instance or for one project, with a route-bound cursor for continuation.
List available change request reviewersList users who are available to review or approve a change request in the specified project environment.
List available impact metricsReturns all available impact metrics and their metadata.
Get all bannersReturns a list of all configured banners.
List requested change request reviewersGet the users currently requested to review a change request.
List change requests for a projectThis endpoint will retrieve all change requests regardless of status for a given project.
List Context FieldsList configured root context fields or project context fields.
Get a list of all users that have created eventsReturns a list of all users that have created events in the system.
Get all features lifecycle stage countReturn instance-wide feature flag counts grouped into the initial, pre-live, live, completed, and archived lifecycle stages.
List FeaturesList every feature flag in one project with its high-level state in each environment.
Get all tags for a featureRetrieves all the tags for a feature name.
Get a list of groupsGet a list of user groups for Role-Based Access Control.
List impact metric configurationsList impact metric chart configurations for either the Unleash instance (not associated with a feature flag) or one feature flag.
List inactive usersGets all inactive users.
List integration events for a specific integration configurationReturns a list of integration events belonging to a specific integration configuration, identified by its id.
List invoicesReturn 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.
Get all login eventsReturn all login and logout events in the Unleash system as structured JSON, including success, client, and failure details when available.
List notificationsA user may get relevant notifications from the projects they are a member of
List outdated SDKsLists outdated SDK versions and the applications using them across the instance or in one project.
List parent optionsList available parents who have no transitive dependencies.
List parent feature variantsList available parent variants across all strategy variants and feature environment variants.
Get all personal access tokens (PATs) for the current userReturns all of the [personal access tokens](https://docs.
List pending change requests referencing a featureThis endpoint will retrieve all pending change requests (change requests with a status of Draft | In review | Approved) referencing the given feature flag name.
List available permissionsReturns a list of available permissions.
List Project EnvironmentsList environments available to a project with project-specific visibility and enabled-toggle counts.
Get a list of all flag creators for a projectThis endpoint returns every user who created a flag in the project.
List ProjectsList projects available to the connected Admin API principal, optionally including archived projects.
List public signup tokensRetrieves all existing public signup tokens.
List release plansReturns a list of all release plans for a specific feature flag and environment.
List release templatesLists global release templates or templates for one project.
Get a list of rolesGet a list of project, root and custom roles for Role-Based Access Control.
List SegmentsList all reusable segments in the Unleash instance with their constraints and usage counts.
List strategy segmentsRetrieve all segments that are referenced by the specified strategy.
List service accountsReturns the list of all service accounts.
List all tokens for a service accountReturns the list of all tokens for a service account identified by the id.
[BETA] List signal endpoints**[BETA]** This API is in beta state, which means it may change or be removed in the future.
[BETA] List signals from a specific signal endpoint**[BETA]** This API is in beta state, which means it may change or be removed in the future.
[BETA] List tokens for a specific signal endpoint**[BETA]** This API is in beta state, which means it may change or be removed in the future.
[BETA] List signals**[BETA]** Returns one page of signals in the requested creation-date range.
List strategies that reference a segmentRetrieve all strategies that reference the specified segment.
List Strategy TypesList predefined and custom strategy types available for feature configuration.
List all tagsList all tags available in Unleash.
List all tags of a given typeList all tags of a given type.
Get all tag typesGet a list of all available tag types.
List unknown flagsReturns a list of unknown flag reports from the last 24 hours, if any.
Get all pending user access requestsReturns a list of all pending user access requests.
List roles for the currently logged-in userGets roles assigned to currently logged in user.
Get all users and [root roles](https://docs.getunleash.io/concepts/rbac#predefined-roles)Will return all users and all available root roles for the Unleash instance.
Mark notifications as readAllow to select which notifications were read and saving a read date
Create (overwrite) variants for a feature in an environmentReplace the feature flag's complete variant list in one environment.
Create (overwrite) variants for a feature flag in multiple environmentsReplace the feature flag's complete variant list in every environment named by environments.
Patch a feature's variants in an environmentApply a list of patches to the features environments in the specified environment.
Modify a feature flagChange specific properties of a feature flag.
Change specific properties of a strategyChange specific properties of a strategy configuration in a feature flag.
Query impact metrics time series dataQueries an impact metric source for time series data based on the provided metric name, time range, and aggregation mode.
Reads the Unleash licenseReads the Unleash license.
Register a new impact metricRegisters a new impact metric by pushing 0-values.
Reject a user access requestRejects an existing user access request identified by its id.
Remove an environment from a projectThis endpoint removes the specified environment from the project.
Remove project access for a groupRemoves project access for a group by removing all of its roles for the project.
Remove project access for a userRemoves project access for a user by removing all of its roles for the project.
Generate user password-reset URLGenerates and returns a password-reset URL for the user identified by email; it does not change the password.
Resume paused milestone progressionsResumes all paused milestone progressions for a release plan
Revives a featureThis endpoint revives the specified feature from archive.
Revives a list of featuresThis endpoint revives the specified features.
Save impact metric configurationCreate or update an instance-level or feature-level impact metric chart configuration.
Search change requestsSearch and filter change requests by creator and approver.
Search for eventsAllows searching for events that match the query parameter criteria.
Search FeaturesSearch and filter feature flags across projects.
Search usersIt will preform a simple search based on name and email matching the given query.
Set Action Set StateEnable or disable one project action set.
Set Banner StateEnable or disable an instance banner.
Set change request reviewersReplace the requested reviewers for a change request with the complete supplied user-ID list.
Sets allowed CORS originsSets Cross-Origin Resource Sharing headers for Frontend SDK API.
Set Email SubscriptionSubscribe or unsubscribe the current principal from an email notification category.
Set Environment StateEnable or disable an environment across the Unleash instance.
Set the external impact-metrics sourceUpdates the configuration of the external impact-metrics source (any Prometheus-compatible endpoint).
Set Feature Environment StateEnable or disable one feature flag in one environment.
Set Feature FavoriteAdd or remove one feature flag from the current principal's favorites.
Set Feature Lifecycle CompletionMark a feature lifecycle as completed with a kept or discarded outcome, or mark it incomplete again.
Set Features Environment StateEnable or disable the supplied feature flags in one project environment.
Mark features as stale / not staleThis endpoint marks the provided list of features as either [stale](https://docs.
Enable or disable maintenance modeEnable or disable maintenance mode for the entire Unleash instance.
Set OIDC settingsConfigure or partially update OpenID Connect login, user auto-creation, roles, group syncing, PKCE, and scopes.
Set users and groups to roles in the current projectReplaces the complete project access configuration with the supplied role assignments.
Set Project ArchivedArchive or revive one project; archiving requires all project flags to be archived first.
Set Project FavoriteAdd or remove one project from the current principal's favorites.
Toggle remote MCP server settingsToggles the remote MCP server for this Unleash instance.
Sets roles for groupReplace all project roles assigned to a group.
Sets roles for userReplace all project roles assigned directly to a user.
Update SAML auth settingsConfigure or partially update SAML login, certificates, user auto-creation, roles, and group syncing.
Set SCIM settingsSets new settings for SCIM provisioning.
Set Signal Endpoint StateEnable or disable one outbound signal endpoint.
Update Simple auth settingsEnable or disable simple authentication (username/password).
Set Strategy DeprecatedDeprecate or reactivate one custom strategy type.
Set strategy sort orderReplace the sort order for the complete supplied list of strategy instances in this feature environment.
Start a release plan milestoneStarts a release plan milestone, advancing a one-way release transition that may apply the milestone's rollout configuration and cannot simply be undone.
[BETA] Update an action set**[BETA]** This API is in beta state, which means it may change or be removed in the future.
Update an addonReplace an external event integration configuration.
Update a bannerUpdates an existing banner identified by its id.
Edits a single change in a change requestReplace one change in a change request.
This endpoint will update the state of a change requestMove a change request to Draft, In review, Approved, Cancelled, or Applied when Unleash's transition rules allow it.
This endpoint will update the custom title of a change requestReplace a change request's custom title.
Update Context FieldUpdate supplied settings of a root or project context field.
Updates an environment by nameGiven an environment by name updates the environment with the given payload.
Update environment sort ordersUpdates sort orders for the named environments.
Update FeatureUpdate supplied description, type, stale or archive state, or impression-data setting on an existing feature flag.
Update a feature linkUpdate an existing feature link.
Update Feature StrategyReplace supplied configuration fields on one feature strategy instance.
Update strategy segmentsSets the segments of the strategy specified to be exactly the ones passed in the payload.
Update feature tagsSync one or many feature tags with PUT, add one tag with POST, or remove one tag with DELETE.
Update feature type lifetimeUpdates the lifetime configuration for the specified [feature flag type](https://docs.
Update a groupUpdate existing user group by group id.
Set a new Unleash licenseSet a new Unleash license.
Update projectUpdate a project's name and optionally its description, access mode, or default stickiness.
Updates change request configuration for an environment in the projectThis endpoint will change the change request configuration for a given environment, set it to either on/off and optionally configure the number of approvals needed.
Update project enterprise settingsUpdate project enterprise settings with new values.
Update a milestone strategyUpdate a milestone strategy configuration for a feature flag in the specified environment.
Update a release templateUpdates a release template's name, description, and replacement milestone configuration.
Update a roleUpdate a custom role by its role ID.
Update SegmentUpdate a segment by replacing its required name and complete constraint list plus optional metadata.
Update a service accountUpdates an existing service account 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.
[BETA] Update a signal endpoint token**[BETA]** This API is in beta state, which means it may change or be removed in the future.
Update a strategy typeUpdate a custom strategy type's optional description and replace its complete parameter definition list.
Update a tag typeUpdate the configuration for the specified tag type.
Update a userOnly the explicitly specified fields get updated.
Upsert Context Field Legal ValueAdd a legal value to a root or project context field, or update its description when the value already exists.
Create or update safeguardCreate or update a metric-threshold safeguard for a feature environment or for one release plan.
Validates archive featuresPreview the consequences of archiving the named feature flags.
Validate constraintValidates a constraint definition.
Validate Context Field NameCheck whether a proposed name can be used for a root or project context field.
Validates if an environment name existsChecks whether an environment name is already in use.
Validate an external impact-metrics source URLTests an external impact-metrics source URL on the fly without persisting it.
Validate a feature flag nameValidates a feature flag name: checks whether the name is URL-friendly and whether a feature with the given name already exists.
Validate feature import dataValidates a feature flag data set.
Validate project IDValidate a project ID against Unleash's rules
Validate a roleCheck if the role matches schema and has a unique name.
Validates if a segment name existsChecks whether a segment name is already in use.
Validate a tag typeValidates whether if the body of the request is a valid tag and whether the a tag type with that name already exists or not.
Validate password for a userValidate the password strength.