- Category: developer tools
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 297
- Triggers: 0
- Slug:
UNLEASH - Version: 20261101_00
Tools
Configure project access
Configure project access
This endpoint will add a comment to a change request
This endpoint will add a comment to a change request
Set environment-default strategy
Set environment-default strategy
UNLEASH_ADD_DEFAULT_STRATEGY_TO_PROJECT_ENVIRONMENTSets 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.Input Parameters
Output
Add environments to a project
Add environments to a project
UNLEASH_ADD_ENVIRONMENTS_TO_PROJECTSequentially 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.Input Parameters
Output
Add an environment to a project
Add an environment to a project
UNLEASH_ADD_ENVIRONMENT_TO_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.Input Parameters
Output
Add feature dependencies
Add feature dependencies
UNLEASH_ADD_FEATURE_DEPENDENCIESAdd 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.Input Parameters
Output
Add a feature dependency
Add a feature dependency
Add Feature Strategy
Add Feature Strategy
Add a release plan
Add a release plan
UNLEASH_ADD_RELEASE_PLANAdds a release plan to a specific feature flag and environment.Input Parameters
Output
Approve a user access request
Approve a user access request
Archive Feature
Archive Feature
Archives a list of features
Archives a list of features
UNLEASH_ARCHIVE_FEATURESThis 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.Input Parameters
Output
Archive a release template
Archive a release template
Create or update a milestone progression
Create or update a milestone progression
UNLEASH_CHANGE_MILESTONE_PROGRESSIONCreates 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.Input Parameters
Output
Change your own password
Change your own password
Move feature to project
Move feature to project
UNLEASH_CHANGE_PROJECTMoves 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.Input Parameters
Output
Create/Add change to a change request
Create/Add change to a change request
UNLEASH_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.Input Parameters
Output
Change password for a user
Change password for a user
Check dependencies exist
Check dependencies exist
Validates the Unleash license
Validates the Unleash license
Clones an environment
Clones an environment
Clone a feature flag
Clone a feature flag
UNLEASH_CLONE_FEATURECreate a copy of the specified feature flag in its project, with a new name and an optional group ID setting.Input Parameters
Output
[BETA] Create an action set
[BETA] Create an action set
Create a new addon
Create a new addon
UNLEASH_CREATE_ADDONCreate 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.Input Parameters
Output
Create API token
Create API token
UNLEASH_CREATE_API_TOKENCreate 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.Input Parameters
projects.Output
Create an application to connect reported metrics
Create an application to connect reported metrics
UNLEASH_CREATE_APPLICATIONCreate 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.Input Parameters
Output
Create Context Field
Create Context Field
Creates a new environment
Creates a new environment
UNLEASH_CREATE_ENVIRONMENTUses the details provided in the payload to create a new environmentInput Parameters
development - test - preproduction - production If you pass a string that is not one of the recognized values, Unleash will accept it, but it will carry no special semantics.false to create the environment in a disabled state.Output
Create Feature
Create Feature
Create a feature link
Create a feature link
Create a new group
Create a new group
Create a new personal access token (PAT) for the current user
Create a new personal access token (PAT) for the current user
UNLEASH_CREATE_PATCreates 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.Input Parameters
Output
Create project
Create project
UNLEASH_CREATE_PROJECTCreate a new Unleash project.Input Parameters
environments list, they will still have change requests enabled.Output
Create a project API token
Create a project API token
UNLEASH_CREATE_PROJECT_API_TOKENCreate 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.Input Parameters
Output
Create a public signup token
Create a public signup token
UNLEASH_CREATE_PUBLIC_SIGNUP_TOKENLets 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.Input Parameters
Output
Create a release template
Create a release template
UNLEASH_CREATE_RELEASE_TEMPLATECreates and returns a release template with its name, optional nullable description, and optional milestone configuration. Project scope uses a beta API.Input Parameters
Output
Create a new role
Create a new role
Create Segment
Create Segment
Create a service account
Create a service account
Create a token for a service account
Create a token for a service account
[BETA] Create a signal endpoint
[BETA] Create a signal endpoint
[BETA] Create a signal endpoint token for a specific signal endpoint
[BETA] Create a signal endpoint token for a specific signal endpoint
UNLEASH_CREATE_SIGNAL_ENDPOINT_TOKEN[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.Input Parameters
Output
Create a strategy
Create a strategy
Create a new tag
Create a new tag
UNLEASH_CREATE_TAGCreate a new tag with the specified data.Input Parameters
Output
Create a new user
Create a new user
[BETA] Delete an action set
[BETA] Delete an action set
Delete an addon
Delete an addon
Delete an application
Delete an application
Discards a change from a change request by change id
Discards a change from a change request by change id
UNLEASH_DELETE_CHANGEThis endpoint will discard one change from a change request if it matches the provided id.Input Parameters
Output
Deletes a change request by id
Deletes a change request by id
Delete Context Field
Delete Context Field
Delete Context Field Legal Value
Delete Context Field Legal Value
UNLEASH_DELETE_CONTEXT_FIELD_LEGAL_VALUEPermanently 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.Input Parameters
Output
Delete an environment
Delete an environment
Deletes an archived feature
Deletes an archived feature
Delete feature dependencies
Delete feature dependencies
Delete a feature dependency
Delete a feature dependency
Delete a feature link
Delete a feature link
UNLEASH_DELETE_FEATURE_LINKDelete a feature link by id.Input Parameters
Output
Deletes a list of features
Deletes a list of features
Delete Feature Strategy
Delete Feature Strategy
Delete a single group
Delete a single group
Delete impact metric configuration
Delete impact metric configuration
Deletes inactive users
Deletes inactive users
UNLEASH_DELETE_INACTIVE_USERSDeletes 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.Input Parameters
Output
Delete a milestone progression
Delete a milestone progression
UNLEASH_DELETE_MILESTONE_PROGRESSIONDeletes an existing milestone progression by source milestone ID.Input Parameters
Output
Delete a personal access token (PAT) for the current user
Delete a personal access token (PAT) for the current user
UNLEASH_DELETE_PATPermanently 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.Input Parameters
Output
Delete project
Delete project
UNLEASH_DELETE_PROJECTPermanently 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.Input Parameters
Output
Delete a release plan
Delete a release plan
UNLEASH_DELETE_RELEASE_PLANDelete a release plan from a specific feature flag and environment.Input Parameters
Output
Delete a release template
Delete a release template
Delete a custom role
Delete a custom role
UNLEASH_DELETE_ROLEDelete 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.Input Parameters
Output
Delete safeguard
Delete safeguard
UNLEASH_DELETE_SAFEGUARDPermanently 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.Input Parameters
Output
Delete all SCIM groups
Delete all SCIM groups
Delete all SCIM users
Delete all SCIM users
Delete Segment
Delete Segment
Delete a service account
Delete a service account
Delete a token for a service account
Delete a token for a service account
UNLEASH_DELETE_SERVICE_ACCOUNT_TOKENPermanently 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.Input Parameters
Output
[BETA] Delete a signal endpoint
[BETA] Delete a signal endpoint
[BETA] Delete a signal endpoint token
[BETA] Delete a signal endpoint token
UNLEASH_DELETE_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.Input Parameters
Output
Delete a strategy
Delete a strategy
Delete a tag
Delete a tag
UNLEASH_DELETE_TAGDelete a tag by type and value. When a tag is deleted all references to the tag are removed.Input Parameters
Output
Delete a tag type
Delete a tag type
Delete a user
Delete a user
[BETA] Disconnect all clients
[BETA] Disconnect all clients
Export feature flags from an environment
Export feature flags from an environment
UNLEASH_EXPORT_FEATURESExport 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.Input Parameters
Output
Generates a new SCIM API token
Generates a new SCIM API token
Gets access overview
Gets access overview
Get the number of change requests you can do something with
Get the number of change requests you can do something with
Get a specific addon
Get a specific addon
Get total count of admin accounts
Get total count of admin accounts
Batch evaluate an Unleash context against a set of environments and projects
Batch evaluate an Unleash context against a set of environments and projects
UNLEASH_GET_ADVANCED_PLAYGROUNDUse 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.Input Parameters
Output
Get application data
Get application data
UNLEASH_GET_APPLICATIONReturns 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.Input Parameters
Output
Get application environment instances (Last 24h)
Get application environment instances (Last 24h)
UNLEASH_GET_APPLICATION_ENVIRONMENT_INSTANCESReturns an overview of the instances for the given appName and environment that have received traffic in the last 24 hours.Input Parameters
Output
Get application overview
Get application overview
Get basic user and group information
Get basic user and group information
Retrieves one change request by id
Retrieves one change request by id
Evaluate an Unleash context against a change request preview
Evaluate an Unleash context against a change request preview
UNLEASH_GET_CHANGE_REQUEST_PLAYGROUNDUse 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.Input Parameters
Output
Retrieves number of project change requests in each state
Retrieves number of project change requests in each state
[BETA] Get aggregated metered connections for a given time period
[BETA] Get aggregated metered connections for a given time period
Get Context Field
Get Context Field
Get Detailed Invoices
Get Detailed Invoices
Get the environment with name
Get the environment with name
Get variants for a feature in an environment
Get variants for a feature in an environment
UNLEASH_GET_ENVIRONMENT_FEATURE_VARIANTSReturns the variants for a feature in a specific environment. If the feature has no variants it will return an empty array of variantsInput Parameters
Output
Get the external impact-metrics source
Get the external impact-metrics source
Get Feature
Get Feature
Get Feature Environment
Get Feature Environment
Get feature lifecycle
Get feature lifecycle
UNLEASH_GET_FEATURE_LIFECYCLEReturn 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.Input Parameters
Output
Get feature flag strategies
Get feature flag strategies
UNLEASH_GET_FEATURE_STRATEGIESGet strategies defined for a feature flag in the specified environment.Input Parameters
Output
Get a strategy configuration
Get a strategy configuration
UNLEASH_GET_FEATURE_STRATEGYGet a strategy configuration for an environment in a feature flag.Input Parameters
Output
Last hour of usage and a list of applications that have reported seeing this feature flag
Last hour of usage and a list of applications that have reported seeing this feature flag
Get a single group
Get a single group
Instance usage statistics
Instance usage statistics
Instance usage statistics
Instance usage statistics
Get instance information
Get instance information
Get licensed user statistics
Get licensed user statistics
Get lifecycle trends
Get lifecycle trends
Get maintenance mode status
Get maintenance mode status
Get your own user details
Get your own user details
Get OIDC auth settings
Get OIDC auth settings
Retrieves pending change requests in configured environments
Retrieves pending change requests in configured environments
UNLEASH_GET_PENDING_CHANGE_REQUESTS_FOR_USERThis endpoint will retrieve the pending change requests in the configured environments for the project, for the current user performing the request.Input Parameters
Output
Get Plausible analytics data
Get Plausible analytics data
Get your own user profile
Get your own user profile
Get users and groups in project
Get users and groups in project
Get api tokens for project
Get api tokens for project
UNLEASH_GET_PROJECT_API_TOKENSReturns the project-specific API tokens that have been created for this project.Input Parameters
Output
Retrieves change request configuration for a project
Retrieves change request configuration for a project
Get an overview of a project
Get an overview of a project
UNLEASH_GET_PROJECT_OVERVIEWThis 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.Input Parameters
Output
Get project status
Get project status
Get feature metrics
Get feature metrics
Get a release template
Get a release template
Get remote MCP server settings
Get remote MCP server settings
[BETA] Get aggregated metered requests for a given time period
[BETA] Get aggregated metered requests for a given time period
Gets usage data
Gets usage data
Get a single role
Get a single role
Get project-role mappings
Get project-role mappings
UNLEASH_GET_ROLE_PROJECT_ACCESSFor 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.Input Parameters
Output
Get SAML auth settings
Get SAML auth settings
Get scheduled change requests matching a query
Get scheduled change requests matching a query
Get SCIM settings
Get SCIM settings
Get Segment
Get Segment
Returns the list of permissions for the service account
Returns the list of permissions for the service account
Get Simple auth settings
Get Simple auth settings
Get strategies that use a context field
Get strategies that use a context field
UNLEASH_GET_STRATEGIES_BY_CONTEXT_FIELDRetrieves 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.Input Parameters
Output
Get a strategy definition
Get a strategy definition
Get a tag by type and value
Get a tag by type and value
UNLEASH_GET_TAGGet a tag by type and value. Can be used to check whether a given tag already exists in Unleash or not.Input Parameters
Output
Get a tag type
Get a tag type
Get telemetry settings
Get telemetry settings
UNLEASH_GET_TELEMETRY_SETTINGSProvides the configured settings for telemetry information collectionOutput
Get aggregated traffic data for a given time period
Get aggregated traffic data for a given time period
Get user
Get user
Import feature flags
Import feature flags
UNLEASH_IMPORT_TOGGLESImport 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.Input Parameters
Output
[BETA] List events for an action set
[BETA] List events for an action set
[BETA] List action sets
[BETA] List action sets
Get all addons and providers
Get all addons and providers
Get all environments
Get all environments
Get all feature types
Get all feature types
List API tokens
List API tokens
List API tokens by name
List API tokens by name
UNLEASH_LIST_API_TOKENS_BY_NAMERetrieves 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.Input Parameters
Output
Get all applications
Get all applications
UNLEASH_LIST_APPLICATIONSReturns one page of applications across the Unleash instance or for one project, with a route-bound cursor for continuation.Input Parameters
Output
List available change request reviewers
List available change request reviewers
UNLEASH_LIST_AVAILABLE_CHANGE_REQUEST_REVIEWERSList users who are available to review or approve a change request in the specified project environment.Input Parameters
Output
List available impact metrics
List available impact metrics
List requested change request reviewers
List requested change request reviewers
List change requests for a project
List change requests for a project
UNLEASH_LIST_CHANGE_REQUESTS_FOR_PROJECTThis 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.Input Parameters
Output
List Context Fields
List Context Fields
Get a list of all users that have created events
Get a list of all users that have created events
Get all features lifecycle stage count
Get all features lifecycle stage count
List Features
List Features
Get a list of groups
Get a list of groups
List impact metric configurations
List impact metric configurations
UNLEASH_LIST_IMPACT_METRIC_CONFIGSList impact metric chart configurations for either the Unleash instance (not associated with a feature flag) or one feature flag.Input Parameters
Output
List inactive users
List inactive users
List integration events for a specific integration configuration
List integration events for a specific integration configuration
UNLEASH_LIST_INTEGRATION_EVENTSReturns 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.Input Parameters
Output
List invoices
List invoices
Get all login events
Get all login events
List notifications
List notifications
List outdated SDKs
List outdated SDKs
List parent options
List parent options
List parent feature variants
List parent feature variants
Get all personal access tokens (PATs) for the current user
Get all personal access tokens (PATs) for the current user
UNLEASH_LIST_PATSReturns all of the personal access tokens (PATs) belonging to the current user. Treat token or credential values as secrets and never log them.Output
List pending change requests referencing a feature
List pending change requests referencing a feature
UNLEASH_LIST_PENDING_CHANGE_REQUESTS_FOR_FEATUREThis endpoint will retrieve all pending change requests (change requests with a status of Draft | In review | Approved) referencing the given feature flag name.Input Parameters
Output
List available permissions
List available permissions
List Project Environments
List Project Environments
Get a list of all flag creators for a project
Get a list of all flag creators for a project
List Projects
List Projects
List public signup tokens
List public signup tokens
List release plans
List release plans
UNLEASH_LIST_RELEASE_PLANSReturns a list of all release plans for a specific feature flag and environment.Input Parameters
Output
List release templates
List release templates
UNLEASH_LIST_RELEASE_TEMPLATESLists 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.Input Parameters
Output
Get a list of roles
Get a list of roles
List Segments
List Segments
List strategy segments
List strategy segments
List service accounts
List service accounts
List all tokens for a service account
List all tokens for a service account
[BETA] List signal endpoints
[BETA] List signal endpoints
[BETA] List signals from a specific signal endpoint
[BETA] List signals from a specific signal endpoint
UNLEASH_LIST_SIGNAL_ENDPOINT_SIGNALS[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.Input Parameters
Output
[BETA] List tokens for a specific signal endpoint
[BETA] List tokens for a specific signal endpoint
UNLEASH_LIST_SIGNAL_ENDPOINT_TOKENS[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.Input Parameters
Output
[BETA] List signals
[BETA] List signals
UNLEASH_LIST_SIGNALS[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.Input Parameters
Output
List strategies that reference a segment
List strategies that reference a segment
List Strategy Types
List Strategy Types
Get all tag types
Get all tag types
List unknown flags
List unknown flags
Get all pending user access requests
Get all pending user access requests
List roles for the currently logged-in user
List roles for the currently logged-in user
Get all users and root roles
Get all users and root roles
Mark notifications as read
Mark notifications as read
Create (overwrite) variants for a feature in an environment
Create (overwrite) variants for a feature in an environment
UNLEASH_OVERWRITE_ENVIRONMENT_FEATURE_VARIANTSReplace 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.Input Parameters
Output
Create (overwrite) variants for a feature flag in multiple environments
Create (overwrite) variants for a feature flag in multiple environments
UNLEASH_OVERWRITE_FEATURE_VARIANTS_ON_ENVIRONMENTSReplace 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.Input Parameters
Output
Patch a feature's variants in an environment
Patch a feature's variants in an environment
UNLEASH_PATCH_ENVIRONMENTS_FEATURE_VARIANTSApply RFC 6902 JSON patches to a feature flag’s variants in a specified environment.Input Parameters
Output
Modify a feature flag
Modify a feature flag
UNLEASH_PATCH_FEATUREChange specific properties of a feature flag.Input Parameters
Output
Change specific properties of a strategy
Change specific properties of a strategy
UNLEASH_PATCH_FEATURE_STRATEGYChange specific properties of a strategy configuration in a feature flag.Input Parameters
Output
Query impact metrics time series data
Query impact metrics time series data
UNLEASH_QUERY_IMPACT_METRICS_TIME_SERIESQueries an impact metric source for time series data based on the provided metric name, time range, and aggregation mode.Input Parameters
edit (default) also returns the available labels for the metric (used by filter UIs). display skips label discovery and returns time-series data only (cheaper; use for dashboard rendering).Output
Reads the Unleash license
Reads the Unleash license
Register a new impact metric
Register a new impact metric
Reject a user access request
Reject a user access request
Remove an environment from a project
Remove an environment from a project
UNLEASH_REMOVE_ENVIRONMENT_FROM_PROJECTThis endpoint removes the specified environment from the project.Input Parameters
Output
Remove project access for a group
Remove project access for a group
UNLEASH_REMOVE_GROUP_ACCESSRemoves project access for a group by removing all of its roles for the project.Input Parameters
Output
Remove project access for a user
Remove project access for a user
UNLEASH_REMOVE_USER_ACCESSRemoves project access for a user by removing all of its roles for the project.Input Parameters
Output
Generate user password-reset URL
Generate user password-reset URL
Resume paused milestone progressions
Resume paused milestone progressions
UNLEASH_RESUME_MILESTONE_PROGRESSIONSResumes all paused milestone progressions for a release planInput Parameters
Output
Revives a feature
Revives a feature
Revives a list of features
Revives a list of features
Save impact metric configuration
Save impact metric configuration
UNLEASH_SAVE_IMPACT_METRIC_CONFIGCreate or update an instance-level or feature-level impact metric chart configuration. Omit id to create one; provide its id to update it.Input Parameters
Output
Search change requests
Search change requests
UNLEASH_SEARCH_CHANGE_REQUESTSSearch and filter change requests by creator and approver.Input Parameters
Output
Search for events
Search for events
UNLEASH_SEARCH_EVENTSAllows searching for events that match the query parameter criteria.Input Parameters
Output
Search Features
Search Features
UNLEASH_SEARCH_FEATURESSearch and filter feature flags across projects. Returns one offset-paginated page; pass cursor unchanged to continue the same search.Input Parameters
Output
Search users
Search users
Set Action Set State
Set Action Set State
Set change request reviewers
Set change request reviewers
UNLEASH_SET_CHANGE_REQUEST_REVIEWERSReplace 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.Input Parameters
Output
Sets allowed CORS origins
Sets allowed CORS origins
Set Email Subscription
Set Email Subscription
Set Environment State
Set Environment State
Set the external impact-metrics source
Set the external impact-metrics source
UNLEASH_SET_EXTERNAL_IMPACT_METRICS_SOURCEUpdates the configuration of the external impact-metrics source (any Prometheus-compatible endpoint).Input Parameters
https://user:pass@metrics.example.com); they are extracted into an Authorization header on outbound requests. Required (non-empty, valid URL) when enabled is true; an empty string is discarded when enabled is false.true, url must be a valid non-empty URL.Output
Set Feature Environment State
Set Feature Environment State
Set Feature Favorite
Set Feature Favorite
UNLEASH_SET_FEATURE_FAVORITEAdd or remove one feature flag from the current principal’s favorites.Input Parameters
Output
Set Feature Lifecycle Completion
Set Feature Lifecycle Completion
Set Features Environment State
Set Features Environment State
UNLEASH_SET_FEATURES_ENVIRONMENT_STATEEnable or disable the supplied feature flags in one project environment.Input Parameters
Output
Mark features as stale / not stale
Mark features as stale / not stale
UNLEASH_SET_FEATURES_STALE_STATEThis endpoint marks the provided list of features as either stale or not stale depending on the request body you send. Any provided features that don’t exist are ignored.Input Parameters
true, the features will be marked as stale. If false, the features will be marked as not stale.Output
Enable or disable maintenance mode
Enable or disable maintenance mode
UNLEASH_SET_MAINTENANCE_STATEEnable 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.Input Parameters
Output
Set OIDC settings
Set OIDC settings
Set users and groups to roles in the current project
Set users and groups to roles in the current project
UNLEASH_SET_PROJECT_ACCESSReplaces 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.Input Parameters
Output
Set Project Archived
Set Project Archived
Set Project Favorite
Set Project Favorite
Toggle remote MCP server settings
Toggle remote MCP server settings
Sets roles for group
Sets roles for group
UNLEASH_SET_ROLES_FOR_GROUPReplace 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.Input Parameters
Output
Sets roles for user
Sets roles for user
UNLEASH_SET_ROLES_FOR_USERReplace 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.Input Parameters
Output
Update SAML auth settings
Update SAML auth settings
UNLEASH_SET_SAML_SETTINGSConfigure 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.Input Parameters
Output
Set SCIM settings
Set SCIM settings
Set Signal Endpoint State
Set Signal Endpoint State
Update Simple auth settings
Update Simple auth settings
Set Strategy Deprecated
Set Strategy Deprecated
Set strategy sort order
Set strategy sort order
UNLEASH_SET_STRATEGY_SORT_ORDERReplace the sort order for the complete supplied list of strategy instances in this feature environment.Input Parameters
Output
Start a release plan milestone
Start a release plan milestone
UNLEASH_START_MILESTONEStarts a release plan milestone, advancing a one-way release transition that may apply the milestone’s rollout configuration and cannot simply be undone.Input Parameters
Output
[BETA] Update an action set
[BETA] Update an action set
Update an addon
Update an addon
UNLEASH_UPDATE_ADDONReplace 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.Input Parameters
Output
Edits a single change in a change request
Edits a single change in a change request
UNLEASH_UPDATE_CHANGE_REQUEST_CHANGEReplace 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.Input Parameters
Output
This endpoint will update the state of a change request
This endpoint will update the state of a change request
UNLEASH_UPDATE_CHANGE_REQUEST_STATEMove 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.Input Parameters
Output
This endpoint will update the custom title of a change request
This endpoint will update the custom title of a change request
UNLEASH_UPDATE_CHANGE_REQUEST_TITLEReplace 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.Input Parameters
Output
Update Context Field
Update Context Field
Updates an environment by name
Updates an environment by name
UNLEASH_UPDATE_ENVIRONMENTGiven an environment by name updates the environment with the given payload. Note that name, enabled and protected cannot be changed by this APIInput Parameters
Output
Update environment sort orders
Update environment sort orders
Update Feature
Update Feature
Update a feature link
Update a feature link
UNLEASH_UPDATE_FEATURE_LINKUpdate an existing feature link.Input Parameters
Output
Update Feature Strategy
Update Feature Strategy
Update strategy segments
Update strategy segments
UNLEASH_UPDATE_FEATURE_STRATEGY_SEGMENTSSets 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.Input Parameters
Output
Update feature type lifetime
Update feature type lifetime
UNLEASH_UPDATE_FEATURE_TYPE_LIFETIMEUpdates the lifetime configuration for the specified feature flag type. 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.Input Parameters
null or 0, then the feature flags of that type will never be marked as potentially stale. Otherwise, they will be considered potentially stale after the number of days indicated by this property.Output
Update a group
Update a group
UNLEASH_UPDATE_GROUPUpdate existing user group by group id. It overrides previous group details.Input Parameters
Output
Set a new Unleash license
Set a new Unleash license
Update project
Update project
UNLEASH_UPDATE_PROJECTUpdate 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.Input Parameters
Output
Updates change request configuration for an environment in the project
Updates change request configuration for an environment in the project
UNLEASH_UPDATE_PROJECT_CHANGE_REQUEST_CONFIGUpdate 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.Input Parameters
Output
Update project enterprise settings
Update project enterprise settings
UNLEASH_UPDATE_PROJECT_ENTERPRISE_SETTINGSUpdate project enterprise settings with new values. Any fields not provided are ignored.Input Parameters
Output
Update a milestone strategy
Update a milestone strategy
UNLEASH_UPDATE_PROJECT_MILESTONE_STRATEGYUpdate a milestone strategy configuration for a feature flag in the specified environment.Input Parameters
Output
Update a release template
Update a release template
UNLEASH_UPDATE_RELEASE_TEMPLATEUpdates 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.Input Parameters
Output
Update a role
Update a role
UNLEASH_UPDATE_ROLEUpdate 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.Input Parameters
Output
Update Segment
Update Segment
Update a service account
Update a service account
[BETA] Update a signal endpoint
[BETA] Update a signal endpoint
[BETA] Update a signal endpoint token
[BETA] Update a signal endpoint token
UNLEASH_UPDATE_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.Input Parameters
Output
Update a strategy type
Update a strategy type
UNLEASH_UPDATE_STRATEGYUpdate 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.Input Parameters
Output
Update a tag type
Update a tag type
Update a user
Update a user
Upsert Context Field Legal Value
Upsert Context Field Legal Value
UNLEASH_UPSERT_CONTEXT_FIELD_LEGAL_VALUEAdd 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.Input Parameters
Output
Create or update safeguard
Create or update safeguard
UNLEASH_UPSERT_SAFEGUARDCreate 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.Input Parameters
Output
Validates archive features
Validates archive features
UNLEASH_VALIDATE_ARCHIVE_FEATURESPreview 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.Input Parameters
Output
Validate constraint
Validate constraint
UNLEASH_VALIDATE_CONSTRAINTValidates 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.Input Parameters
values for properties that only accept single values.value for properties that accept multiple values.true, will turn a true result into a false result and vice versa.false (being case sensitive).Output
Validate Context Field Name
Validate Context Field Name
UNLEASH_VALIDATE_CONTEXT_FIELD_NAMECheck 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.Input Parameters
Output
Validates if an environment name exists
Validates if an environment name exists
Validate an external impact-metrics source URL
Validate an external impact-metrics source URL
UNLEASH_VALIDATE_EXTERNAL_IMPACT_METRICS_SOURCETests 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.Input Parameters
https://user:pass@metrics.example.com); they are extracted into an Authorization header on outbound requests.Output
Validate a feature flag name
Validate a feature flag name
UNLEASH_VALIDATE_FEATUREValidates 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.Input Parameters
Output
Validate feature import data
Validate feature import data
UNLEASH_VALIDATE_IMPORTValidates 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.Input Parameters
Output
Validate project ID
Validate project ID
Validate a role
Validate a role
Validates if a segment name exists
Validates if a segment name exists
Validate a tag type
Validate a tag type
Validate password for a user
Validate password for a user
UNLEASH_VALIDATE_USER_PASSWORDValidate the password strength. Minimum 10 characters, uppercase letter, number, special character. Treat token or credential values as secrets and never log them.