Skip to main content
Unleash logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 297
  • Triggers: 0
  • Slug: UNLEASH
  • Version: 20261101_00

Tools

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

Input Parameters

array
required
A list of role IDs
array
required
A list of user IDs
array
required
A list of group IDs
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_ADD_CHANGE_REQUEST_COMMENTThis endpoint will add a comment to a change request for the user making the request.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
The content of the comment.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the strategy type
string
A descriptive title for the strategy
boolean
A toggle to disable the strategy. defaults to false. Disabled strategies are not evaluated or returned to the SDKs
array
Ids of segments to use for this strategy
array
Strategy level variants
object
A list of parameters for a strategy
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
number
The order of the strategy in the list
array
A list of the constraints attached to the strategy. See https://docs.getunleash.io/concepts/activation-strategies#constraints
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Exact project ID that will gain the environment associations.
array
required
Non-empty list of uniquely named environments and their association-local change-request and default-strategy configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Exact project ID that will gain the environment association.
string
required
Exact name of an existing environment to associate with the project.
object
Default activation strategy to create for this project-environment association and apply when enabling feature flags.
boolean
Whether to enable change requests for this project-environment association.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project ID containing the child and parent feature flags.
array
required
Non-empty dependency list. Parent feature names must be unique.
string
required
Exact child feature flag name that will depend on each requested parent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_ADD_FEATURE_DEPENDENCYAdd a dependency to a parent feature. Each environment will resolve corresponding dependency independently.

Input Parameters

boolean
Required enabled state of the parent. Omit for Unleash’s default; when false, variants are ignored.
array
Acceptable parent variant names. Omit or use an empty list to check only the enabled state.
string
required
Project ID containing the child and parent feature flags.
string
required
Exact child feature flag name that will depend on the parent feature flag.
string
required
Exact parent feature flag name on which the child will depend.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_ADD_FEATURE_STRATEGYAdd one activation strategy configuration to a feature flag in an environment.

Input Parameters

string
required
Strategy type name, such as flexibleRollout or default.
string
Human-readable title for this strategy instance.
boolean
Whether this strategy instance is disabled.
array
Numeric segment IDs attached to this strategy.
array
Experimental strategy-level variants.
object
Provider-defined strategy parameters; values must be strings.
string
required
Project ID containing the feature flag.
number
Evaluation order for the strategy.
array
Constraints that must match for the strategy.
string
required
Environment name, such as development or production.
string
required
Exact feature flag name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_ADD_RELEASE_PLANAdds a release plan to a specific feature flag and environment.

Input Parameters

string
required
Project sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
The release plan template’s ID. Release template IDs are ulids.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_ADD_TAG_TO_FEATURESAdd 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.

Input Parameters

object
required
Represents a set of changes to a feature’s tags, such as adding or removing tags.
array
required
The list of features that will be affected by the tag changes.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_APPROVE_USER_ACCESS_REQUESTApproves a pending user access request, creating a new user with the specified role.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
integer
required
The ID of the root role to assign to the new user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_ARCHIVE_FEATUREArchive a feature flag in a project. The feature can be revived in Unleash, but revival is not performed by this action.

Input Parameters

string
required
Project ID containing the feature flag.
string
required
Exact feature flag name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of feature flag names
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_ARCHIVE_RELEASE_TEMPLATEArchives a global release template or a template scoped to one project. The project branch is a beta API.

Input Parameters

string ("global" | "project")
required
Whether to archive a global template or a template for one project. The project-scoped API is beta.
string
Project ID. Required only when scope is project and forbidden for global.
string
required
ID of the release template to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Project sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
The ID of the target milestone
string
required
A transition condition for milestone progression

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CHANGE_MY_PASSWORDImmediately replaces the connected user’s password after verifying the old password and confirmation. Treat credentials as secrets and never log them.

Input Parameters

string
required
The new password. Treat this value as a secret and never log it.
string
required
The connected user’s current password. Treat this value as a secret and never log it.
string
required
Confirmation of the new password. Treat this value as a secret and never log it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
The project to move the feature flag to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
One typed change or a list of typed changes. The action discriminator selects the exact required payload for updateSegment, deleteSegment, updateEnabled, addStrategy, updateMilestoneStrategy, updateStrategy, deleteStrategy, archiveFeature, patchVariant, reorderStrategy, addDependency, deleteDependency, addReleasePlan, startMilestone, deleteReleasePlan, changeMilestoneProgression, deleteMilestoneProgression, resumeMilestoneProgression, changeReleasePlanSafeguard, deleteReleasePlanSafeguard, changeFeatureEnvSafeguard, or deleteFeatureEnvSafeguard.
string
required
Project ID in which to create a change request or add a change.
string
required
Environment name where the proposed change will eventually apply.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CHANGE_USER_PASSWORDImmediately replaces a user’s password as an administrator. Treat credentials as secrets and never log them.

Input Parameters

integer
required
a user id
string
required
The user’s new password. Treat this value as a secret and never log it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CHECK_DEPENDENCIES_EXISTCheck whether dependencies exist for a specified Unleash project.

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CHECK_LICENSECheck the current Enterprise license and return whether it is valid, along with any provider status message and its info, warning, or error severity.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CLONE_ENVIRONMENTGiven an existing environment name and a set of options, this will create a copy of that environment

Input Parameters

string
required
Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Updates the type of environment (i.e. development or production).
array
required
A list of projects that should be included in the cloned environment.
string
required
The name of the new cloned environment, this cannot be changed later
boolean
Copies the RBAC permissions from the source environment if true. Defaults to true

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the new feature
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.
boolean
Whether to use the new feature name as its group ID or not. Group ID is used for calculating stickiness. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_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.

Input Parameters

string
required
The name of the action set
object
required
Defines a matching rule for the signal that will trigger the action set
array
required
The list of actions to execute in sequential order when the action set is triggered
boolean
Whether this action set is enabled or not
integer
required
The id of the service account that will execute the action
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
The description of the action set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Destination URL for webhook, Slack webhook, Teams, Datadog, New Relic, or Teams Workflow delivery. Required for webhook, slack, teams, new-relic, and the teams-workflow or teamsworkflow identifier returned by the instance. Treated as secret because webhook URLs can contain credentials.
array
required
Event types to deliver. Use LIST_ADDONS to discover those supported by the selected provider.
string
Datadog API key. Required for the datadog provider; never log it.
boolean
required
Whether to begin delivering selected events as soon as the addon is created.
array
Project IDs to deliver events from. Omit or pass an empty list for all projects.
string
required
Case-sensitive addon provider name returned by LIST_ADDONS. Providers are instance-discovered and may include custom integrations.
string
Slack webhook username. Applies only to the slack provider and defaults to “Unleash”.
string
Slack webhook emoji icon. Applies only to the slack provider and defaults to “:unleash:”.
string
Human-readable addon description.
string
New Relic license key. Required for the new-relic provider; never log it.
string
App for Slack access token. Required for the slack-app provider; never log it.
string
Webhook Content-Type header. Applies only to the webhook provider and defaults to application/json.
array
Environment names to deliver events from. Omit or pass an empty list for all environments.
string
Mustache body template for webhook, Datadog, or New Relic delivery.
object
Additional outbound HTTP headers as string key-value pairs. Supported by webhook, slack, teams, datadog, new-relic, and the teams-workflow or teamsworkflow identifier returned by the instance. Header values may contain secrets.
string
Fallback Slack channel when an event has no Slack tag. Required for the slack provider.
array
Slack App channels that always receive selected events, in addition to channels selected by Slack tags.
string
Datadog event source_type_name. Applies only to the datadog provider.
object
Provider-specific parameter object using the exact keys documented by LIST_ADDONS. Use this for custom or instance-defined providers; values may contain credentials and must not be logged. Do not combine a key here with its equivalent typed field.
string
Value Unleash sends in the webhook Authorization header. Applies only to the webhook provider; never log it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("client" | "backend" | "frontend")
required
Token type. Use “backend” instead of the deprecated “client” type, or “frontend” for browser clients.
string
Single project the token can access. Omit both project selectors for all projects (”*”). Mutually exclusive with projects.
array
Projects the token can access. Mutually exclusive with project.
string
ISO 8601 date and time when the token should expire.
string
required
Unique display name for the token; this is not the token secret.
string
Environment the token can access; defaults to “default”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
A link to reference the application reporting the metrics. Could for instance be a GitHub link to the repository of the application
string
An URL to an icon file to be used for the applications’s entry in the application list
string
Css color to be used to color the application’s entry in the application list
string
required
App Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.
array
Which strategies the application has loaded. Useful when trying to figure out if your custom strategy has been loaded in the SDK

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_BANNERCreates a new banner.

Input Parameters

string
The icon to display on the banner. Can be one of https://fonts.google.com/icons. If not specified, this will be the default icon for the variant. If “none”, no icon will be displayed.
The link to display on the banner. Can either be an absolute or a relative link (e.g. absolute: “https://example.com” or relative: “/admin/service-accounts”). If “dialog”, will display a dialog when clicked. If not specified, no link will be displayed.
string
The markdown to display on the dialog. If not specified, no dialog will be displayed.
boolean
Whether the banner should be sticky on the screen. If not specified, defaults to false.
boolean
Whether the banner should be displayed currently. If not specified, defaults to true.
string
required
The message to display to all users. Supports markdown.
string ("info" | "warning" | "error" | "success")
The variant of the banner. One of “info”, “warning”, “error”, or “success”. If not specified, defaults to “info”.
The text to display on the link. If not specified, will be displayed as “More info”.
string
The title to display on the dialog. If not specified, this will be the same as linkText.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_CONTEXT_FIELDCreate a root context field or a project context field. The project scope uses Unleash’s beta project-context API.

Input Parameters

string
required
Name of the context field to create.
string ("root" | "project")
required
Use root context fields or the beta context fields for one project.
string
Optional project association stored on the context field.
string
Project ID. Required only when scope is project.
integer
Order used when listing context fields.
boolean
Whether this field can be used for custom stickiness calculations.
string
Optional context-field description.
Allowed values for this context field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_ENVIRONMENTUses the details provided in the payload to create a new environment

Input Parameters

string
required
The name of the environment. Must be a URL-friendly string according to RFC 3968, section 2.3
string
required
The type of environment you would like to create. Unleash officially recognizes the following values: - 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.
boolean
Newly created environments are enabled by default. Set this property to false to create the environment in a disabled state.
integer
Defines where in the list of environments to place this environment. The list uses an ascending sort, so lower numbers are shown first. You can change this value later.
integer
Experimental field. The number of approvals required before a change request can be applied in this environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_FEATURECreate a feature flag in a project without enabling it in any environment.

Input Parameters

string
required
Unique feature flag name.
array
Tags to attach to the feature at creation time.
string ("experiment" | "kill-switch" | "release" | "operational" | "permission" | "sunset")
Feature flag type.
string
required
Project ID that will contain the feature flag.
string
Detailed feature description.
boolean
Whether to collect impression data for the feature.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_GROUPCreates an Enterprise user group for role-based access control, with optional SSO mappings, predefined root role, and initial user membership.

Input Parameters

string
required
The name of the group
array
A list of users belonging to this group
integer ("1" | "2" | "3")
Predefined root role ID applied to all group members: 1 (Admin), 2 (Editor), or 3 (Viewer).
string
A custom description of the group
array
A list of SSO groups that should map to this Unleash group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The PAT’s expiration date.
string
required
The PAT’s description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_PROJECTCreate a new Unleash project.

Input Parameters

string
The project’s identifier. If this property is not present or is an empty string, Unleash will generate the project id automatically. This property is deprecated.
string ("open" | "protected" | "private")
A mode of the project affecting what actions are possible in this project
string
required
The project’s name. The name must contain at least one non-whitespace character.
string
The project’s description.
array
A list of environments that should be enabled for this project. If this property is missing, Unleash will default to enabling all non-deprecated environments for the project. An empty list will result in no environment enabled for the project.
string
A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy
array
A list of environments that should have change requests enabled. If the list includes environments not in the environments list, they will still have change requests enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("client" | "backend" | "frontend")
required
Token type. Use “backend” instead of the deprecated “client” type, or “frontend” for browser clients.
string
The date and time when the token should expire. The date should be in ISO 8601 format.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
A unique name for this particular token
string
The environment that the token should be valid for. Defaults to “default”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The token’s name.
string
required
The token’s expiration date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The release template’s name.
string ("global" | "project")
required
Whether to create a global template or a template for one project. The project-scoped API is beta.
array
Milestones to include in the release template.
string
Project ID. Required only when scope is project and forbidden for global.
string
The release template’s description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_ROLECreate a new custom role for Role-Based Access Control.

Input Parameters

string
required
Name for the new custom role.
string ("root-custom" | "custom")
Role scope: “root-custom” applies across the instance; “custom” is a project role.
string
What the custom role is intended for.
array
Permissions assigned to the role, identified consistently by permission name or numeric permission ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_SEGMENTCreate a reusable segment from a name and complete constraint list.

Input Parameters

string
required
Segment name.
string
Project ID that owns the segment, or omit for a global segment.
array
required
Complete list of constraints that define the segment.
string
What this segment represents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_SERVICE_ACCOUNTCreates a new service account.

Input Parameters

string
required
The name of the service account
string
required
The username of the service account
integer
required
The id of the root role for the service account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_SERVICE_ACCOUNT_TOKENCreates 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.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
The PAT’s expiration date.
string
required
The PAT’s description.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_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.

Input Parameters

string
required
The signal endpoint name. Must be URL-safe.
boolean
Whether the signal endpoint is currently enabled. If not specified, defaults to true.
string
A more detailed description of the signal endpoint and its intended use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The signal endpoint token name.
string
required
Signal Endpoint Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_STRATEGYCreates a custom strategy type based on the supplied data.

Input Parameters

string
required
The name of the strategy type. Must be unique.
string
The title of the strategy
boolean
Whether the strategy type is editable or not. Defaults to true.
boolean
Whether the strategy type is deprecated or not. Defaults to false.
array
required
The parameter list lets you pass arguments to your custom activation strategy. These will be made available to your custom strategy implementation.
string
A description of the strategy type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_TAGCreate a new tag with the specified data.

Input Parameters

string
required
The type of the tag
string
The hexadecimal color code for the tag type.
string
required
The value of the tag. The value must be between 2 and 50 characters long. Leading and trailing whitespace is ignored and will be trimmed before saving the tag value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_TAG_TYPECreate a new tag type.

Input Parameters

string
The icon of the tag type.
string
required
The name of the tag type.
string
The hexadecimal color code for the tag type.
string
The description of the tag type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_CREATE_USERCreates 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.

Input Parameters

string
The user’s name (not the user’s username).
string
The user’s email address. Must be provided if username is not provided.
string
Password for the user. Treat this value as a secret and never log it.
string
The user’s username. Must be provided if email is not provided.
string
required
The role to assign to the user. Can be either the role’s ID or its unique name.
boolean
Whether to send a welcome email with a login link to the user or not. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_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.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_ADDONDelete the addon specified by the ID in the request path.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_APPLICATIONDelete the specified application.

Input Parameters

string
required
App Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_BANNERDeletes an existing banner identified by its id.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_CHANGEThis endpoint will discard one change from a change request if it matches the provided id.

Input Parameters

string
required
Change Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Change Request Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_CHANGE_REQUESTThis endpoint will delete one change request if it matches the provided id.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_CONTEXT_FIELDPermanently 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.

Input Parameters

string ("root" | "project")
required
Use root context fields or the beta context fields for one project.
string
Project ID. Required only when scope is project.
string
required
Exact name of the context field to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_ENVIRONMENTDelete an environment identified by name.

Input Parameters

string
required
Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_FEATUREPermanently this endpoint deletes the specified feature if it is archived. If the feature is not archived, it is left unchanged.

Input Parameters

string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_FEATURE_DEPENDENCIESRemove all parent feature dependencies from one child feature flag.

Input Parameters

string
required
Project ID containing the child feature flag.
string
required
Exact child feature flag name whose parent dependencies will all be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_FEATURE_DEPENDENCYRemove one named parent feature dependency from a child feature flag.

Input Parameters

string
required
Project ID containing the child and parent feature flags.
string
required
Exact child feature flag name from which the dependency will be removed.
string
required
Exact parent feature flag name to remove from the child’s dependencies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_FEATURESPermanently this endpoint deletes the specified features, that are in archive.

Input Parameters

array
required
List of feature flag names
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_FEATURE_STRATEGYPermanently delete one activation strategy instance from a feature flag in an environment.

Input Parameters

string
required
Project ID containing the feature flag.
string
required
Environment name, such as development or production.
string
required
Strategy instance ID returned by Get Feature Environment.
string
required
Exact feature flag name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_GROUPDelete a single user group by group id. This operation changes access or identity state and may be destructive or immediately disruptive.

Input Parameters

string
required
Group Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_IMPACT_METRIC_CONFIGPermanently delete one impact metric chart configuration by config_id from the instance-level collection or from one feature flag.

Input Parameters

string ("instance" | "feature")
required
Configuration target: instance or feature.
string
required
ULID of the impact metric configuration to permanently delete from the selected target.
string
Project ID containing the feature flag. Required only when target is feature.
string
Exact feature flag name. Required only when target is feature.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
IDs of inactive users to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_MILESTONE_PROGRESSIONDeletes an existing milestone progression by source milestone ID.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Project sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Numeric personal access token ID returned by the PAT listing action; this is not the token secret.
boolean
required
Set to true only after independently verifying this PAT is not the credential backing the current Composio connection. Composio cannot compare the opaque connection credential with this provider token ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_RELEASE_PLANDelete a release plan from a specific feature flag and environment.

Input Parameters

string
required
Plan Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Project sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_RELEASE_TEMPLATEPermanently deletes a global release template or a template scoped to one project. The project branch is a beta API.

Input Parameters

string ("global" | "project")
required
Whether to delete a global template or a template for one project. The project-scoped API is beta.
string
Project ID. Required only when scope is project and forbidden for global.
string
required
ID of the release template to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Role Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("feature_environment" | "release_plan")
required
Safeguard target: the feature environment itself or one release plan.
string
Release plan ID. Required only when target is release_plan.
string
required
Project ID containing the feature flag.
string
required
Environment name containing the safeguard.
string
required
Exact feature flag name.
string
required
ID of the safeguard to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_SCIM_GROUPSDeletes all groups managed by SCIM. This operation changes access or identity state and may be destructive or immediately disruptive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_SCIM_USERSDeletes all users managed by SCIM. This operation changes access or identity state and may be destructive or immediately disruptive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_SEGMENTPermanently delete a segment by numeric ID. Unleash rejects deletion while the segment is in use.

Input Parameters

integer
required
Numeric segment ID returned by List Segments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_SERVICE_ACCOUNTDeletes an existing service account identified by its id. This operation changes access or identity state and may be destructive or immediately disruptive.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Service account token ID returned by the token listing action; this is not the token secret.
string
required
Service account ID that owns the token.
boolean
required
Set to true only after independently verifying this service account token is not the credential backing the current Composio connection. Composio cannot compare the opaque connection credential with this provider token ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_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.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Signal Endpoint Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_STRATEGYDeletes the specified strategy definition

Input Parameters

string
required
Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_TAGDelete a tag by type and value. When a tag is deleted all references to the tag are removed.

Input Parameters

string
required
Type sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Value sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_TAG_TYPEDeletes a tag type. If any features have tags of this type, those tags will be deleted.

Input Parameters

string
required
Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DELETE_USERDeletes the user with the given userId. This operation changes access or identity state and may be destructive or immediately disruptive.

Input Parameters

integer
required
a user id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_DISCONNECT_ALL[BETA] This API is in beta state, which means it may change or be removed in the future. Disconnects all streaming clients.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Export feature flags with this tag. Provide exactly one of features, tag, or project.
string
Export feature flags from this project. Provide exactly one of features, tag, or project.
array
Feature flag names to export. An empty list selects all feature flags. Provide exactly one of features, tag, or project.
string
required
Environment whose feature flag configuration to export.
boolean
Whether Unleash should deliver the JSON export as a downloadable file. This endpoint does not offer CSV exports.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GENERATE_SCIM_TOKENGenerates 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_ACCESS_OVERVIEWGets an overview of what access all users have to all projects and groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_ACTIONABLE_CHANGE_REQUESTSReturns the number of change requests in this project that your user can move into the next stage by approving or applying them.

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_ADDONRetrieve information about the addon whose ID matches the ID in the request URL.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_ADMIN_COUNTGet a total count of admins with password, without password and admin service accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The Unleash context as modeled in client SDKs
string
A list of projects to check for toggles in.
array
required
The environments to evaluate toggles in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
App Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
App Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_APPLICATION_OVERVIEWReturn an application’s projects, feature count, environment and SDK activity, and missing-feature, outdated-SDK, or missing-strategy issues.

Input Parameters

string
required
App Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_BASE_USERS_AND_GROUPSGet a subset of user and group information eligible even for non-admin users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_CHANGE_REQUESTThis endpoint will retrieve one change request if it matches the provided id.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
object
required
The Unleash context as modeled in client SDKs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_CHANGE_REQUESTS_COUNTThis endpoint will retrieve the number of project change requests that are: approved, applied, rejected, scheduled or awaiting review

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_CONNECTIONS_FOR_PERIOD[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.

Input Parameters

string
required
The starting date of the traffic data usage search in IS:yyyy-MM-dd format
string
required
The starting date of the traffic data usage search in IS:yyyy-MM-dd format
string ("daily" | "monthly")
required
Whether to aggregate the data by month or by day

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_CONTEXT_FIELDGet one root or project context field by name. The project scope uses Unleash’s beta project-context API.

Input Parameters

string ("root" | "project")
required
Use root context fields or the beta context fields for one project.
string
Project ID. Required only when scope is project.
string
required
Exact name of the context field to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_ENVIRONMENTRetrieves the environment with name if it exists in this Unleash instance

Input Parameters

string
required
Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 variants

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_EXTERNAL_IMPACT_METRICS_SOURCEReturns the current configuration of the external impact-metrics source (any Prometheus-compatible endpoint).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_FEATUREGet one feature flag with its metadata, lifecycle, dependencies, tags, environment enablement, and strategy configurations.

Input Parameters

string
required
Project ID containing the feature flag.
string
required
Exact feature flag name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_FEATURE_ENVIRONMENTGet a feature flag’s enablement state, complete strategy configurations, variants, release plans, and safeguards in one environment.

Input Parameters

string
required
Project ID containing the feature flag.
string
required
Environment name, such as development or production.
string
required
Exact feature flag name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_FEATURE_STRATEGIESGet strategies defined for a feature flag in the specified environment.

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_FEATURE_STRATEGYGet a strategy configuration for an environment in a feature flag.

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Strategy Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_FEATURE_USAGE_SUMMARYSeparate counts for yes (enabled), no (disabled), as well as how many times each variant was selected during the last hour

Input Parameters

string
required
Exact feature flag name whose usage summary should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_GROUPGet a single user group by group id.

Input Parameters

string
required
Group Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_INSTANCE_ADMIN_STATSProvides 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_INSTANCE_ADMIN_STATS_CSVDownload a CSV file of self-hosted instance usage statistics, including counts and version data for users, groups, feature flags, and strategies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_INSTANCE_INSIGHTSGets high level information about the usage of this Unleash instance, including user, project, and flag information.

Input Parameters

string
The end of the date range in yyyy-MM-dd format
string
The beginning of the date range in yyyy-MM-dd format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_LICENSED_USER_STATSReturn the available seat count, current license usage, and monthly licensed-user count history for this Unleash instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_MAINTENANCETells you whether maintenance mode is enabled or disabled

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_MEDetailed information about the current user, user permissions and user feedback.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_OIDC_SETTINGSReturns 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_PLAUSIBLE_METRICSFetches analytics data from Plausible API for favorite events over the last 7 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_PROFILEDetailed information about the current user root role and project membership.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_PROJECT_ACCESSGet all groups, users and their roles, and available roles for the given project.

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_PROJECT_API_TOKENSReturns the project-specific API tokens that have been created for this project.

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_PROJECT_CHANGE_REQUEST_CONFIGGiven a projectId, this endpoint will retrieve change request configuration for the project

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_PROJECT_STATUSThis endpoint returns information on the status the project, including activities, health, resources, and aggregated flag lifecycle data.

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_RAW_FEATURE_METRICSGet usage metrics for a specific feature for the last 48 hours, grouped by hour

Input Parameters

string
required
Exact feature flag name whose hourly usage metrics should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_RELEASE_TEMPLATEReturns a global release template or a template scoped to one project. The project branch is a beta API.

Input Parameters

string ("global" | "project")
required
Whether to read a global template or a template for one project. The project-scoped API is beta.
string
Project ID. Required only when scope is project and forbidden for global.
string
required
ID of the release template to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_REMOTE_MCP_SETTINGSReturns the current settings for the remote MCP server.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_REQUESTS_FOR_PERIOD[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.

Input Parameters

string
required
The starting date of the traffic data usage search in IS:yyyy-MM-dd format
string
required
The starting date of the traffic data usage search in IS:yyyy-MM-dd format
string ("daily" | "monthly")
required
Whether to aggregate the data by month or by day

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_REQUESTS_PER_SECONDGets usage data per app/endpoint from a prometheus compatible metrics endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_ROLE_BY_IDGet a single role by role id.

Input Parameters

string
required
Role Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Role Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_SAML_SETTINGSReturns the current settings for SAML authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_SCHEDULED_CHANGE_REQUESTSList 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.

Input Parameters

string
Exact feature flag name touched by a scheduled change request.
string
required
Project ID containing the scheduled change requests.
string
Exact activation strategy ID touched by a scheduled change request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_SCIM_SETTINGSReturns the current settings for SCIM provisioning.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_SEGMENTGet one reusable segment and its complete constraint definition by numeric ID.

Input Parameters

integer
required
Numeric segment ID returned by List Segments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_SERVICE_ACCOUNT_PERMISSIONSGets a list of permissions for a service account. Project and environment can be specified.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
Project sent in the request query. See the cited Admin OpenAPI schema for accepted values.
string
Environment sent in the request query. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_SIMPLE_SETTINGSIs simple authentication (username/password) enabled for this server.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("root" | "project")
required
Whether to inspect the root context field or a context field in one project. The project-scoped API is beta.
string
Project ID. Required only when scope is project and forbidden for root.
string
required
Exact context field name whose strategies should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_STRATEGYRetrieves the definition of the strategy specified in the URL

Input Parameters

string
required
Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Type sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Value sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_TAG_TYPEGet a tag type by name.

Input Parameters

string
required
Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_TELEMETRY_SETTINGSProvides the configured settings for telemetry information collection

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_TRAFFIC_DATA_USAGE_FOR_PERIODGets traffic usage data for the selected period, either aggregated by day or by month.

Input Parameters

string
required
The starting date of the traffic data usage search in IS:yyyy-MM-dd format
string
required
The starting date of the traffic data usage search in IS:yyyy-MM-dd format
string ("daily" | "monthly")
required
Whether to aggregate the data by month or by day

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_GET_USERWill return a single user by id.

Input Parameters

integer
required
a user id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The result of the export operation, providing you with the feature flag definitions, strategy definitions and the rest of the elements relevant to the features (tags, environments etc.)
string
required
The exported project
string
required
The exported environment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_ACTION_SET_EVENTS[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.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
integer
The number of results to return in a page. By default it is set to 50.
string
Continuation cursor returned by the previous call. Pass it unchanged to fetch the next page.
integer
The number of results to skip on the first page. Defaults to 0.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_ACTION_SETS[BETA] Returns the action sets for a specified project. The API may change or be removed.

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_ADDONSRetrieve all addons and providers that are defined on this Unleash instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_ALL_ENVIRONMENTSRetrieves all environments that exist in this Unleash instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_ALL_FEATURE_TYPESRetrieves all feature types that exist in this Unleash instance, along with their descriptions and lifetimes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_API_TOKENSRetrieves all API tokens that exist in the Unleash instance. Treat token or credential values as secrets and never log them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_APPLICATIONSReturns one page of applications across the Unleash instance or for one project, with a route-bound cursor for continuation.

Input Parameters

integer
Applications per page. Defaults to 1000 for instance scope and 50 for project scope.
string
The search query for the application name
string ("instance" | "project")
required
Whether to list applications across the instance or in one project.
string
Opaque continuation cursor returned by the previous call. Pass it unchanged to continue with the same scope, project, and filters.
string
The field to sort the results by. By default it is set to “appName”.
string
Project ID. Required only when scope is project and forbidden for instance.
string
The sort order for the sortBy. By default it is det to “asc”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_AVAILABLE_CHANGE_REQUEST_REVIEWERSList users who are available to review or approve a change request in the specified project environment.

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_AVAILABLE_IMPACT_METRICSReturns all available impact metrics and their metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_BANNERSReturns a list of all configured banners.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_CHANGE_REQUEST_REVIEWERSGet the users currently requested to review a change request. These are requested reviewers, not users who have already approved it.

Input Parameters

string
required
Change request ID returned by a change-request read or search action.
string
required
Project ID containing the change request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_CONTEXT_FIELDSList configured root context fields or project context fields. The project scope uses Unleash’s beta project-context API.

Input Parameters

string ("root" | "project")
required
Use root context fields or the beta context fields for one project.
string
Project ID. Required only when scope is project.
boolean
Also return project fields when scope is root, or root fields when scope is project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_EVENT_CREATORSReturns a list of all users that have created events in the system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_FEATURE_LIFECYCLE_STAGE_COUNTReturn 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_FEATURESList every feature flag in one project with its high-level state in each environment.

Input Parameters

string
required
Project ID containing the feature flags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_FEATURE_TAGSRetrieves all the tags for a feature name. If the feature does not exist it returns an empty list.

Input Parameters

string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_GROUPSGet a list of user groups for Role-Based Access Control.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("instance" | "feature")
required
Configuration target: instance for charts not associated with a feature flag, or feature for one feature flag.
string
Project ID containing the feature flag. Required only when target is feature.
string
Exact feature flag name. Required only when target is feature.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_INACTIVE_USERSGets all inactive users. An inactive user is a user that has not logged in in the last 180 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
integer
The number of results to return in a page. By default it is set to 50.
integer
The number of results to skip when returning a page. By default it is set to 0.
string
Opaque cursor from the previous page. Pass it unchanged and do not change id, offset, or limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_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. Use GET_DETAILED_INVOICES when plan pricing and line-item breakdowns are needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_LOGIN_HISTORYReturn all login and logout events in the Unleash system as structured JSON, including success, client, and failure details when available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_NOTIFICATIONSA user may get relevant notifications from the projects they are a member of

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_OUTDATED_SDKSLists outdated SDK versions and the applications using them across the instance or in one project.

Input Parameters

string ("instance" | "project")
required
Whether to list outdated SDKs across the instance or in one project.
string
Project ID. Required only when scope is project and forbidden for instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_PARENT_OPTIONSList available parents who have no transitive dependencies.

Input Parameters

string
required
Project ID containing the child feature flag.
string
required
Exact child feature flag name for which valid parent candidates are requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_PARENT_VARIANT_OPTIONSList available parent variants across all strategy variants and feature environment variants.

Input Parameters

string
required
Project ID containing the parent feature flag.
string
required
Exact parent feature flag name whose available variants will be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_PERMISSIONSReturns a list of available permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_PROJECT_ENVIRONMENTSList environments available to a project with project-specific visibility and enabled-toggle counts.

Input Parameters

string
required
Project ID containing the feature flag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_PROJECT_FLAG_CREATORSThis endpoint returns every user who created a flag in the project.

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_PROJECTSList projects available to the connected Admin API principal, optionally including archived projects.

Input Parameters

boolean
Whether to include archived projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_PUBLIC_SIGNUP_TOKENSRetrieves all existing public signup tokens. Treat token or credential values as secrets and never log them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_RELEASE_PLANSReturns a list of all release plans for a specific feature flag and environment.

Input Parameters

string
required
Project sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("global" | "project")
required
Whether to list global templates or templates for one project. The project-scoped API is beta.
string
Project ID. Required only when scope is project and forbidden for global.
boolean
For project scope, also include global templates. Not valid for global scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_ROLESGet a list of project, root and custom roles for Role-Based Access Control.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_SEGMENTSList all reusable segments in the Unleash instance with their constraints and usage counts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_SEGMENTS_BY_STRATEGY_IDRetrieve all segments that are referenced by the specified strategy. Returns an empty list of segments if the strategy ID doesn’t exist.

Input Parameters

string
required
Strategy Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_SERVICE_ACCOUNTSReturns the list of all service accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_SERVICE_ACCOUNT_TOKENSReturns the list of all tokens for a service account identified by the id. Treat token or credential values as secrets and never log them.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_SIGNAL_ENDPOINTS[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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The number of results to return in a page. By default it is set to 50.
integer
The number of results to skip when returning a page. By default it is set to 0.
string
Opaque cursor from the previous page. Pass it unchanged and do not change signal_endpoint_id, offset, or limit.
string
required
Signal Endpoint Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Signal Endpoint Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The ending date of the creation date range in IS:yyyy-MM-dd format
integer
The number of signals to return in a page. Defaults to 50; maximum 1000.
integer
The number of signals to skip on the first page. Defaults to 0.
string
The starting date of the creation date range in IS:yyyy-MM-dd format
string
Opaque cursor from the previous page. Pass it unchanged and do not change the date filters, offset, or limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_STRATEGIES_BY_SEGMENT_IDRetrieve all strategies that reference the specified segment.

Input Parameters

integer
required
a segment id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_STRATEGY_TYPESList predefined and custom strategy types available for feature configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_TAGSList all tags available in Unleash.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_TAGS_BY_TYPEList all tags of a given type. If the tag type does not exist it returns an empty list.

Input Parameters

string
required
Type sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_TAG_TYPESGet a list of all available tag types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_UNKNOWN_FLAGSReturns a list of unknown flag reports from the last 24 hours, if any. Maximum of 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_USER_ACCESS_REQUESTSReturns a list of all pending user access requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_USER_ROLESGet roles assigned to the currently logged-in user for a specified project, including roles assigned directly and through group memberships.

Input Parameters

string
required
The id of the project you want to check permissions for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_LIST_USERSWill return all users and all available root roles for the Unleash instance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_MARK_NOTIFICATIONS_AS_READAllow to select which notifications were read and saving a read date

Input Parameters

array
required
A list of IDs belonging to the notifications you want to mark as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Complete replacement variant list. Pass an empty list to remove all variants from this feature in the environment.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Complete replacement variant list for every named environment. Pass an empty list to remove all variants from those environments.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
array
required
One or more environment names whose complete variant lists will be replaced.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_PATCH_ENVIRONMENTS_FEATURE_VARIANTSApply RFC 6902 JSON patches to a feature flag’s variants in a specified environment.

Input Parameters

array
required
One or more ordered RFC 6902 operations. Each operation requires op and path; add, replace, and test use value, while copy and move use from_.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_PATCH_FEATUREChange specific properties of a feature flag.

Input Parameters

array
required
One or more ordered RFC 6902 operations against feature properties. Each operation requires op and path; add, replace, and test use value, while copy and move use from_.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_PATCH_FEATURE_STRATEGYChange specific properties of a strategy configuration in a feature flag.

Input Parameters

array
required
One or more ordered RFC 6902 operations against this strategy configuration. Each operation requires op and path; add, replace, and test use value, while copy and move use from_.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Strategy Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("display" | "edit")
Query mode. 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).
string ("hour" | "day" | "week" | "month" | "threeMonths" | "sixMonths")
required
The time range for the query.
object
Label names mapped to arrays of accepted label values for filtering.
string ("internal" | "external")
required
Whether the metric comes from the internal Unleash impact metrics or an external source.
string
required
The Prometheus metric name to query.
string ("rps" | "count" | "avg" | "sum" | "p50" | "p95" | "p99")
required
The aggregation mode for the query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_READ_LICENSEReads the Unleash license. Only available for self-hosted Enterprise customers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_REGISTER_IMPACT_METRICRegisters a new impact metric by pushing 0-values.

Input Parameters

string
required
The metric name. Must start with a letter or underscore and contain only alphanumerics, underscores or colons.
string ("counter" | "gauge" | "histogram")
required
The type of metric to register.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_REJECT_USER_ACCESS_REQUESTRejects an existing user access request identified by its id. This operation changes access or identity state and may be destructive or immediately disruptive.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_REMOVE_ENVIRONMENT_FROM_PROJECTThis endpoint removes the specified environment from the project.

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_REMOVE_GROUP_ACCESSRemoves project access for a group by removing all of its roles for the project.

Input Parameters

string
required
Group Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_REMOVE_USER_ACCESSRemoves project access for a user by removing all of its roles for the project.

Input Parameters

string
required
User Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_RESET_USER_PASSWORDGenerates 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.

Input Parameters

string
required
Email address of the user who needs a password-reset URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_RESUME_MILESTONE_PROGRESSIONSResumes all paused milestone progressions for a release plan

Input Parameters

string
required
Plan Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Project sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_REVIVE_FEATUREThis endpoint revives the specified feature from archive.

Input Parameters

string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_REVIVE_FEATURESRevives the specified feature flags in a project.

Input Parameters

array
required
List of feature flag names
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Existing configuration ULID to update. Omit it to create a new configuration.
string
Optional impact metric chart title.
string ("internal" | "external")
Prometheus data source for this metric. Defaults to internal.
string ("instance" | "feature")
required
Configuration target: instance for a chart not associated with a feature flag, or feature for one feature flag.
string
Project ID containing the feature flag. Required only when target is feature.
string ("hour" | "day" | "week" | "month")
required
Time range for the metric data.
string ("auto" | "zero")
required
Whether the chart y-axis minimum is automatic or zero.
string
required
Prometheus metric series to query.
string
Exact feature flag name. Required only when target is feature.
object
required
Labels and values used to filter the metric data.
string ("rps" | "count" | "avg" | "sum" | "p95" | "p99" | "p50")
required
Aggregation applied to the metric data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SEARCH_CHANGE_REQUESTSSearch and filter change requests by creator and approver.

Input Parameters

integer
The number of change requests to return in a page. By default it is set to 50. The maximum is 1000.
string ("IS:open" | "IS:closed")
Filter by open / closed change requests. Change requests that are in ‘draft’, ‘in review’, ‘approved’, or ‘scheduled’ states are considered open. Change requests that are in ‘cancelled’, ‘applied’, or ‘rejected’ states are considered closed.
string
Continuation cursor returned by the previous call. Pass it unchanged to fetch the next page.
integer
The number of change requests to skip on the first page. Defaults to 0.
string
Filter by change request creator user ID
string
Filter by requested approver user ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SEARCH_EVENTSAllows searching for events that match the query parameter criteria.

Input Parameters

string
Filter by event ID using supported operators: IS, IS_ANY_OF.
string
The ending date of the creation date range in IS:yyyy-MM-dd format
string
The starting date of the creation date range in IS:yyyy-MM-dd format
string
Filter by event type using supported operators: IS, IS_ANY_OF.
integer
The number of feature environments to return in a page. By default it is set to 50. The maximum is 1000.
string
Find events by a free-text search query. The query will be matched against the event data payload (if any).
string
Opaque continuation cursor returned by the previous call. Pass it unchanged to continue.
string
Filter by feature name using supported operators: IS, IS_ANY_OF
string
Filter by projects ID using supported operators: IS, IS_ANY_OF.
string
Filter by group ID using supported operators: IS, IS_ANY_OF.
string
Filter by the ID of the event creator, using supported operators: IS, IS_ANY_OF.
string
Filter by environment name using supported operators: IS, IS_ANY_OF.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SEARCH_FEATURESSearch and filter feature flags across projects. Returns one offset-paginated page; pass cursor unchanged to continue the same search.

Input Parameters

string
Tag filter in OPERATOR:type:value form. Supported operators include INCLUDE, DO_NOT_INCLUDE, INCLUDE_ALL_OF, INCLUDE_ANY_OF, EXCLUDE_IF_ANY_OF, and EXCLUDE_ALL.
string
Feature-type filter in OPERATOR:value form. Supported operators are IS, IS_NOT, IS_ANY_OF, and IS_NONE_OF.
integer
Maximum number of features in this page (1-100).
string
Text to match against feature names or tags.
string
Active or stale filter in OPERATOR:value form. Supported operators are IS, IS_NOT, IS_ANY_OF, and IS_NONE_OF.
string
Opaque continuation cursor returned by the previous call. Pass it unchanged and omit the other filters when continuing.
array
Environment status filters as environment:status values.
string
Project filter in OPERATOR:value form. Supported operators are IS, IS_NOT, IS_ANY_OF, and IS_NONE_OF.
string
Segment filter in OPERATOR:value form using the tag-filter operators.
string
Provider field used to sort results.
string
Favorite filter, such as IS:true or IS_ANY_OF:true,false.
string
Lifecycle-stage filter in OPERATOR:value form. Supported operators are IS, IS_NOT, IS_ANY_OF, and IS_NONE_OF.
string
Creation-date filter as IS_BEFORE:YYYY-MM-DD or IS_ON_OR_AFTER:YYYY-MM-DD.
string
Creator filter in OPERATOR:value form.
string ("asc" | "desc")
Sort direction.
string
Last-seen filter as IS_BEFORE:YYYY-MM-DD or IS_ON_OR_AFTER:YYYY-MM-DD.
boolean
Whether favorite flags should sort first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SEARCH_USERSIt will preform a simple search based on name and email matching the given query. Requires minimum 2 characters.

Input Parameters

string
The pattern to search in the username or email

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_ACTION_SET_STATEEnable or disable one project action set.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
boolean
required
True for the positive state; false for the inverse state.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_BANNER_STATEEnable or disable an instance banner.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
boolean
required
True for the positive state; false for the inverse state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Change request ID returned by a change-request read or search action.
array
required
The complete desired set of reviewer user IDs. Include IDs to add and omit IDs to remove; pass an empty list to remove all reviewers.
string
required
Project ID containing the change request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_CORSSets Cross-Origin Resource Sharing headers for Frontend SDK API.

Input Parameters

array
The list of origins that the front-end API should accept requests from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_EMAIL_SUBSCRIPTIONSubscribe or unsubscribe the current principal from an email notification category.

Input Parameters

boolean
required
True for the positive state; false for the inverse state.
string
required
Subscription sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_ENVIRONMENT_STATEEnable or disable an environment across the Unleash instance.

Input Parameters

string
required
Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.
boolean
required
True for the positive state; false for the inverse state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_EXTERNAL_IMPACT_METRICS_SOURCEUpdates the configuration of the external impact-metrics source (any Prometheus-compatible endpoint).

Input Parameters

string
Base URL of the external impact-metrics source. Basic-Auth credentials may be embedded in the URL (e.g. 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.
boolean
required
Whether the external impact-metrics source is active. When true, url must be a valid non-empty URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_FEATURE_ENVIRONMENT_STATEEnable or disable one feature flag in one environment.

Input Parameters

boolean
required
True to enable the feature flag in the environment; false to disable it.
string
required
Project ID containing the feature flag.
string
required
Environment name, such as development or production.
string
required
Exact feature flag name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_FEATURE_FAVORITEAdd or remove one feature flag from the current principal’s favorites.

Input Parameters

boolean
required
True for the positive state; false for the inverse state.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_FEATURE_LIFECYCLE_COMPLETIONMark a feature lifecycle as completed with a kept or discarded outcome, or mark it incomplete again.

Input Parameters

string ("kept" | "discarded")
Required when completed is true: final outcome.
boolean
required
True to complete the lifecycle; false to mark it incomplete.
string
required
Project ID containing the feature flag.
string
required
Exact feature flag name.
string
Optional metadata associated with the completion outcome.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_FEATURES_ENVIRONMENT_STATEEnable or disable the supplied feature flags in one project environment.

Input Parameters

boolean
required
True for the positive state; false for the inverse state.
array
required
The features that we want to bulk toggle
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Whether the list of features should be marked as stale or not stale. If true, the features will be marked as stale. If false, the features will be marked as not stale.
array
required
A list of features to mark as (not) stale
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
required
Set true to enable instance-wide maintenance mode and block users from changing configuration. Set false to disable it and restore configuration writes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_OIDC_SETTINGSConfigure 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.

Input Parameters

boolean
Enable or disable OIDC login for this Unleash instance.
string
OIDC application client ID. Required with client_secret for initial configuration.
string
Space-separated Authentication Context Class Reference values.
boolean
Automatically create users from login-token email addresses.
boolean
Enable Proof Key for Code Exchange protection.
string
Space-separated scopes requested in addition to openid, email, and profile.
string
Sensitive OIDC client secret. Required for initial configuration; never log or expose it.
string
OIDC provider’s .well-known discovery URL.
string
Comma-separated email domains approved for auto-creation.
string
Path in the OIDC token response containing group memberships.
boolean
Request the groups scope during OIDC login.
string ("Viewer" | "Editor" | "Admin")
Built-in root role assigned to auto-created users.
number
Numeric root role ID for auto-created users; takes precedence over default_root_role.
boolean
Synchronize Unleash groups from OIDC claims.
boolean
Sign users out of all OIDC client sessions on logout.
string ("RS256" | "RS384" | "RS512")
Algorithm used by the provider to sign ID tokens.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Complete replacement mapping of project role IDs to assigned user and group IDs. An empty roles list removes all project access assignments.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_PROJECT_ARCHIVEDArchive or revive one project; archiving requires all project flags to be archived first.

Input Parameters

boolean
required
True for the positive state; false for the inverse state.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_PROJECT_FAVORITEAdd or remove one project from the current principal’s favorites.

Input Parameters

boolean
required
True for the positive state; false for the inverse state.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_REMOTE_MCP_STATEToggles the remote MCP server for this Unleash instance.

Input Parameters

boolean
required
Whether the remote MCP server is currently enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Complete desired list of project role IDs. This replaces the group’s project roles; an empty list removes them all.
string
required
Numeric group ID returned by an Unleash group or project-access action.
string
required
Project ID whose group role assignments will be replaced.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Complete desired list of project role IDs. This replaces the user’s direct project roles; an empty list removes them all.
string
required
Numeric user ID returned by an Unleash user or project-access action.
string
required
Project ID whose direct user role assignments will be replaced.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Enable or disable SAML 2.0 login for this instance.
string
required
SAML identity-provider entity ID required by Unleash for every update.
boolean
Automatically create users from SAML email claims.
string
X.509 public certificate used to validate identity-provider assertions. Required for initial configuration.
string
Identity-provider Single Sign-On URL. Required for initial configuration.
string
Identity-provider Single Sign-Out URL.
string
Comma-separated email domains approved for auto-creation.
string
Service-provider public certificate for signing logout requests.
string
Path in the SAML assertion containing group memberships.
string ("Viewer" | "Editor" | "Admin")
Built-in root role assigned to auto-created users.
number
Numeric root role ID for auto-created users; takes precedence over default_root_role.
boolean
Synchronize Unleash groups from SAML assertions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_SCIM_SETTINGSSets new settings for SCIM provisioning. This operation changes access or identity state and may be destructive or immediately disruptive.

Input Parameters

boolean
required
Whether SCIM provisioning is currently enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_SIGNAL_ENDPOINT_STATEEnable or disable one outbound signal endpoint.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
boolean
required
True for the positive state; false for the inverse state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_SIMPLE_SETTINGSEnable or disable simple authentication (username/password). This operation changes access or identity state and may be destructive or immediately disruptive.

Input Parameters

boolean
Is username/password authentication disabled

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_STRATEGY_DEPRECATEDDeprecate or reactivate one custom strategy type.

Input Parameters

boolean
required
True for the positive state; false for the inverse state.
string
required
Strategy Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_SET_STRATEGY_SORT_ORDERReplace the sort order for the complete supplied list of strategy instances in this feature environment.

Input Parameters

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.
array
required
Complete ordered list of strategy instance IDs and their numeric sort orders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Plan Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Project sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Milestone Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_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.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
The name of the action set
object
required
Defines a matching rule for the signal that will trigger the action set
array
required
The list of actions to execute in sequential order when the action set is triggered
boolean
Whether this action set is enabled or not
integer
required
The id of the service account that will execute the action
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
The description of the action set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique ID of the addon to update.
string
Destination URL for webhook, Slack webhook, Teams, Datadog, New Relic, or Teams Workflow delivery. Required for webhook, slack, teams, new-relic, and the teams-workflow or teamsworkflow identifier returned by the instance. Treated as secret because webhook URLs can contain credentials.
array
required
Complete replacement event-type filter. Pass an empty list to select no events.
string
Datadog API key. Required for the datadog provider; never log it.
boolean
required
Whether future selected events should be delivered.
array
required
Complete replacement project filter. Pass an empty list for all projects.
string
required
Complete case-sensitive addon provider returned by LIST_ADDONS.
string
Slack webhook username. Applies only to the slack provider and defaults to “Unleash”.
string
Slack webhook emoji icon. Applies only to the slack provider and defaults to “:unleash:”.
string
required
Complete addon description. Pass null to clear it to an empty string.
string
New Relic license key. Required for the new-relic provider; never log it.
string
App for Slack access token. Required for the slack-app provider; never log it.
string
Webhook Content-Type header. Applies only to the webhook provider and defaults to application/json.
array
required
Complete replacement environment filter. Pass an empty list for all environments.
string
Mustache body template for webhook, Datadog, or New Relic delivery.
object
Additional outbound HTTP headers as string key-value pairs. Supported by webhook, slack, teams, datadog, new-relic, and the teams-workflow or teamsworkflow identifier returned by the instance. Header values may contain secrets.
string
Fallback Slack channel when an event has no Slack tag. Required for the slack provider.
array
Slack App channels that always receive selected events, in addition to channels selected by Slack tags.
string
Datadog event source_type_name. Applies only to the datadog provider.
object
Provider-specific parameter object using the exact keys documented by LIST_ADDONS. Use this for custom or instance-defined providers; values may contain credentials and must not be logged. Do not combine a key here with its equivalent typed field.
string
Value Unleash sends in the webhook Authorization header. Applies only to the webhook provider; never log it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_BANNERUpdates an existing banner identified by its id.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
The icon to display on the banner. Can be one of https://fonts.google.com/icons. If not specified, this will be the default icon for the variant. If “none”, no icon will be displayed.
The link to display on the banner. Can either be an absolute or a relative link (e.g. absolute: “https://example.com” or relative: “/admin/service-accounts”). If “dialog”, will display a dialog when clicked. If not specified, no link will be displayed.
string
The markdown to display on the dialog. If not specified, no dialog will be displayed.
boolean
Whether the banner should be sticky on the screen. If not specified, defaults to false.
boolean
Whether the banner should be displayed currently. If not specified, defaults to true.
string
required
The message to display to all users. Supports markdown.
string ("info" | "warning" | "error" | "success")
The variant of the banner. One of “info”, “warning”, “error”, or “success”. If not specified, defaults to “info”.
The text to display on the link. If not specified, will be displayed as “More info”.
string
The title to display on the dialog. If not specified, this will be the same as linkText.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Typed replacement change. The action discriminator selects the exact required payload for updateSegment, deleteSegment, updateEnabled, addStrategy, updateMilestoneStrategy, updateStrategy, deleteStrategy, archiveFeature, patchVariant, reorderStrategy, addDependency, deleteDependency, addReleasePlan, startMilestone, deleteReleasePlan, changeMilestoneProgression, deleteMilestoneProgression, resumeMilestoneProgression, changeReleasePlanSafeguard, deleteReleasePlanSafeguard, changeFeatureEnvSafeguard, or deleteFeatureEnvSafeguard.
string
required
Current change ID from the latest change-request representation. Replacement invalidates this ID, so read the returned request before another edit.
string
required
Project ID containing the change request.
string
required
Change request ID returned by a change-request read or search action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Change request ID returned by a change-request read or search action.
string ("Draft" | "In review" | "Approved" | "Cancelled" | "Applied")
required
Target state. Applied and Cancelled are terminal and cannot be changed afterward.
string
required
Project ID containing the change request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Change request ID returned by a change-request read or search action.
string
required
Replacement custom title. Pass an empty string to clear it and show Unleash’s default title.
string
required
Project ID containing the change request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_CONTEXT_FIELDUpdate supplied settings of a root or project context field. The project scope uses Unleash’s beta project-context API.

Input Parameters

string ("root" | "project")
required
Use root context fields or the beta context fields for one project.
string
Replacement project association for the context field.
string
Project ID. Required only when scope is project.
integer
Replacement order used when listing context fields.
boolean
Whether this field can be used for custom stickiness calculations.
string
Replacement context-field description.
Replacement allowed values for the context field.
string
required
Exact name of the context field to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 API

Input Parameters

string
required
Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
Updates the type of environment (i.e. development or production).
integer
Changes the sort order of this environment.
integer
Experimental field. The number of approvals required before a change request can be applied in this environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_ENVIRONMENT_SORT_ORDERSUpdates sort orders for the named environments. Environments not specified are unaffected.

Input Parameters

object
required
Map of environment names to their desired integer sort orders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_FEATUREUpdate 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.

Input Parameters

string ("experiment" | "kill-switch" | "release" | "operational" | "permission" | "sunset")
Replacement feature type.
boolean
Whether the feature flag is stale.
boolean
Whether to archive the feature flag.
string
required
Project ID containing the feature flag.
string
Replacement feature description.
string
required
Exact feature flag name.
boolean
Whether to collect impression data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_FEATURE_STRATEGYReplace supplied configuration fields on one feature strategy instance.

Input Parameters

string
Replacement strategy type name.
string
Human-readable title for this strategy instance.
boolean
Whether this strategy instance is disabled.
array
Numeric segment IDs attached to this strategy.
array
Experimental strategy-level variants.
object
Provider-defined strategy parameters; values must be strings.
string
required
Project ID containing the feature flag.
number
Evaluation order for the strategy.
array
Constraints that must match for the strategy.
string
required
Environment name, such as development or production.
string
required
Strategy instance ID returned by Get Feature Environment.
string
required
Exact feature flag name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the project that the strategy belongs to.
array
required
The new list of segments (IDs) to use for this strategy. Any segments not in this list will be removed from the strategy.
string
required
The ID of the strategy to update segments for.
string
required
The ID of the strategy environment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_FEATURE_TAGSSync 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.

Input Parameters

object
Required for add: the one tag to send in the POST body.
string
Required for remove: the tag type to send in the DELETE path.
string
Required for remove: the tag value to send in the DELETE path.
string ("sync" | "add" | "remove")
required
Use sync for a batch PUT, add for an exact single-tag POST, or remove for an exact single-tag DELETE.
array
One or more tags to add to the feature, or an empty list when only removing tags.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.
array
One or more tags to remove from the feature, or an empty list when only adding tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The new lifetime (in days) that you want to assign to the feature flag type. If the value is 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.
string
required
Feature flag type ID returned by List All Feature Types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_GROUPUpdate existing user group by group id. It overrides previous group details.

Input Parameters

string
required
The name of the group
array
A list of users belonging to this group
string
required
Group Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
number
A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.
string
A custom description of the group
array
A list of SSO groups that should map to this Unleash group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_LICENSESet a new Unleash license. Only available for self-hosted Enterprise customers.

Input Parameters

string
required
The actual license token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("open" | "protected" | "private")
A mode of the project affecting what actions are possible in this project
string
required
The new name of the project. The name must contain at least one non-whitespace character.
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
A new description for the project
string
A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
integer
The number of approvals required before a change request can be applied in this environment.
boolean
required
true if change requests should be enabled, otherwise false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_PROJECT_ENTERPRISE_SETTINGSUpdate project enterprise settings with new values. Any fields not provided are ignored.

Input Parameters

string ("open" | "protected" | "private")
A mode of the project affecting what actions are possible in this project
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
object
Create a feature naming pattern
A list of link templates that can be automatically added to new feature flags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_PROJECT_MILESTONE_STRATEGYUpdate a milestone strategy configuration for a feature flag in the specified environment.

Input Parameters

string
A descriptive title for the strategy
string
required
Project sent in the request path. See the cited Admin OpenAPI schema for accepted values.
boolean
A toggle to disable the strategy. defaults to true. Disabled strategies are not evaluated or returned to the SDKs
array
A list of segment ids attached to the strategy
array
Strategy level variants
object
A list of parameters for a strategy
number
The order of the strategy in the list in feature environment configuration
array
A list of the constraints attached to the strategy. See https://docs.getunleash.io/concepts/activation-strategies#constraints
string
required
Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Strategy Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The release template’s new name.
string ("global" | "project")
required
Whether to update a global template or a template for one project. The project-scoped API is beta.
array
Replacement milestones. Existing milestones are deleted and rebuilt from this list.
string
Project ID. Required only when scope is project and forbidden for global.
string
The release template’s new description.
string
required
ID of the release template to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Complete name to retain or assign to the custom role; required by the provider for every update.
string ("root-custom" | "custom")
Role scope: “root-custom” applies across the instance; “custom” is a project role.
string
required
Custom role ID returned by the role listing or role lookup action.
string
What the custom role is intended for.
array
Complete permissions to assign when supplied, identified consistently by permission name or numeric permission ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_SEGMENTUpdate a segment by replacing its required name and complete constraint list plus optional metadata.

Input Parameters

string
required
Segment name.
string
Project ID that owns the segment, or null for a global segment.
integer
required
Numeric segment ID returned by List Segments.
array
required
Complete list of constraints that define the segment.
string
What this segment represents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_SERVICE_ACCOUNTUpdates an existing service account identified by its id.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
The name of the service account
integer
The id of the root role for the service account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_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.

Input Parameters

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
The signal endpoint name. Must be URL-safe.
boolean
Whether the signal endpoint is currently enabled. If not specified, defaults to true.
string
A more detailed description of the signal endpoint and its intended use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
required
The signal endpoint token name.
string
required
Signal Endpoint Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.
array
required
Complete replacement parameter definition list for the custom activation strategy. This provider-required field must be supplied even when only changing the description; pass an empty list to remove all parameter definitions.
string
A description of the strategy type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_TAG_TYPEUpdate the configuration for the specified tag type.

Input Parameters

string
The icon of the tag type.
string
required
Name sent in the request path. See the cited Admin OpenAPI schema for accepted values.
string
The hexadecimal color code for the tag type.
string
The description of the tag type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_UPDATE_USERUpdate a user’s email, name, or root role by user ID. Only explicitly specified non-null fields are sent.

Input Parameters

integer
required
a user id
string
The user’s name (not the user’s username).
string
The user’s email address. Must be provided if username is not provided.
string
The role to assign to the user. Can be either the role’s ID or its unique name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("feature_environment" | "release_plan")
required
Safeguard target: the feature environment itself or one release plan.
string
Release plan ID. Required only when target is release_plan.
string
required
Project ID containing the feature flag.
string
required
Environment name containing the safeguard.
string
required
Exact feature flag name.
object
required
Metric configuration evaluated by the safeguard.
object
required
Threshold condition that triggers the safeguard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of feature flag names
string
required
Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The context value that should be used for constraint evaluation. Use this property instead of values for properties that only accept single values.
array
The context values that should be used for constraint evaluation. Use this property instead of value for properties that accept multiple values.
boolean
Whether the result should be negated or not. If true, will turn a true result into a false result and vice versa.
string ("NOT_IN" | "IN" | "STR_ENDS_WITH" | "STR_STARTS_WITH" | "STR_CONTAINS" | "NUM_EQ" | "NUM_GT" | "NUM_GTE" | "NUM_LT" | "NUM_LTE" | "DATE_AFTER" | "DATE_BEFORE" | "SEMVER_EQ" | "SEMVER_GT" | "SEMVER_LT" | "SEMVER_GTE" | "SEMVER_LTE" | "REGEX")
required
The operator to use when evaluating this constraint. For more information about the various operators, refer to the strategy constraint operator documentation.
string
required
The name of the context field that this constraint should apply to.
boolean
Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Proposed context-field name to validate.
string ("root" | "project")
required
Use root context fields or the beta context fields for one project.
string
Project ID. Required only when scope is project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_VALIDATE_ENVIRONMENT_NAMEChecks whether an environment name is already in use.

Input Parameters

string
required
The name of the represented object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Base URL of the external impact-metrics source to test. Basic-Auth credentials may be embedded in the URL (e.g. https://user:pass@metrics.example.com); they are extracted into an Authorization header on outbound requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The feature name to validate.
string
The id of the project that the feature flag will belong to. If the target project has a feature naming pattern defined, the name will be validated against that pattern.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The result of the export operation, providing you with the feature flag definitions, strategy definitions and the rest of the elements relevant to the features (tags, environments etc.)
string
required
The exported project
string
required
The exported environment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_VALIDATE_PROJECTValidate a project ID against Unleash’s rules

Input Parameters

string
required
The project ID to validate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_VALIDATE_ROLECheck if the role matches schema and has a unique name.

Input Parameters

string
required
Role definition to validate. At minimum, provide the custom role name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_VALIDATE_SEGMENTChecks whether a segment name is already in use.

Input Parameters

string
required
The name of the represented object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNLEASH_VALIDATE_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. If a tag type with the same name exists, this operation will return a 409 status code.

Input Parameters

string
The icon of the tag type.
string
required
The name of the tag type.
string
The hexadecimal color code for the tag type.
string
The description of the tag type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

string
required
The password whose strength to validate. Treat this value as a secret and never log it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not