---
canonical_url: "https://docs.composio.dev/toolkits/unleash"
markdown_url: "https://docs.composio.dev/toolkits/unleash.md"
product: "platform"
version: null
last_updated: null
---

# Unleash

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

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 297
- **Triggers:** 0
- **Slug:** `UNLEASH`
- **Version:** 00000000_00

## Tools

### Configure project access

**Slug:** `UNLEASH_ADD_ACCESS_TO_PROJECT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `roles` | array | Yes | A list of role IDs |
| `users` | array | Yes | A list of user IDs |
| `groups` | array | Yes | A list of group IDs |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### This endpoint will add a comment to a change request

**Slug:** `UNLEASH_ADD_CHANGE_REQUEST_COMMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `text` | string | Yes | The content of the comment. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set environment-default strategy

**Slug:** `UNLEASH_ADD_DEFAULT_STRATEGY_TO_PROJECT_ENVIRONMENT`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add environments to a project

**Slug:** `UNLEASH_ADD_ENVIRONMENTS_TO_PROJECT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Exact project ID that will gain the environment associations. |
| `environments` | array | Yes | Non-empty list of uniquely named environments and their association-local change-request and default-strategy configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add an environment to a project

**Slug:** `UNLEASH_ADD_ENVIRONMENT_TO_PROJECT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Exact project ID that will gain the environment association. |
| `environment` | string | Yes | Exact name of an existing environment to associate with the project. |
| `default_strategy` | object | No | Default activation strategy to create for this project-environment association and apply when enabling feature flags. |
| `change_requests_enabled` | boolean | No | Whether to enable change requests for this project-environment association. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add feature dependencies

**Slug:** `UNLEASH_ADD_FEATURE_DEPENDENCIES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID containing the child and parent feature flags. |
| `dependencies` | array | Yes | Non-empty dependency list. Parent feature names must be unique. |
| `child_feature_name` | string | Yes | Exact child feature flag name that will depend on each requested parent. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add a feature dependency

**Slug:** `UNLEASH_ADD_FEATURE_DEPENDENCY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Required enabled state of the parent. Omit for Unleash's default; when false, variants are ignored. |
| `variants` | array | No | Acceptable parent variant names. Omit or use an empty list to check only the enabled state. |
| `project_id` | string | Yes | Project ID containing the child and parent feature flags. |
| `child_feature_name` | string | Yes | Exact child feature flag name that will depend on the parent feature flag. |
| `parent_feature_name` | string | Yes | Exact parent feature flag name on which the child will depend. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Feature Strategy

**Slug:** `UNLEASH_ADD_FEATURE_STRATEGY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Strategy type name, such as flexibleRollout or default. |
| `title` | string | No | Human-readable title for this strategy instance. |
| `disabled` | boolean | No | Whether this strategy instance is disabled. |
| `segments` | array | No | Numeric segment IDs attached to this strategy. |
| `variants` | array | No | Experimental strategy-level variants. |
| `parameters` | object | No | Provider-defined strategy parameters; values must be strings. |
| `project_id` | string | Yes | Project ID containing the feature flag. |
| `sort_order` | number | No | Evaluation order for the strategy. |
| `constraints` | array | No | Constraints that must match for the strategy. |
| `environment` | string | Yes | Environment name, such as development or production. |
| `feature_name` | string | Yes | Exact feature flag name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add a release plan

**Slug:** `UNLEASH_ADD_RELEASE_PLAN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project` | string | Yes | Project sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `template_id` | string | Yes | The release plan template's ID. Release template IDs are ulids. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add and remove tags across features

**Slug:** `UNLEASH_ADD_TAG_TO_FEATURES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | object | Yes | Represents a set of changes to a feature's tags, such as adding or removing tags. |
| `features` | array | Yes | The list of features that will be affected by the tag changes. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Approve a user access request

**Slug:** `UNLEASH_APPROVE_USER_ACCESS_REQUEST`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `root_role` | integer | Yes | The ID of the root role to assign to the new user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive Feature

**Slug:** `UNLEASH_ARCHIVE_FEATURE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID containing the feature flag. |
| `feature_name` | string | Yes | Exact feature flag name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archives a list of features

**Slug:** `UNLEASH_ARCHIVE_FEATURES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `features` | array | Yes | List of feature flag names |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive a release template

**Slug:** `UNLEASH_ARCHIVE_RELEASE_TEMPLATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("global" | "project") | Yes | Whether to archive a global template or a template for one project. The project-scoped API is beta. |
| `project_id` | string | No | Project ID. Required only when scope is `project` and forbidden for `global`. |
| `template_id` | string | Yes | ID of the release template to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create or update a milestone progression

**Slug:** `UNLEASH_CHANGE_MILESTONE_PROGRESSION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project` | string | Yes | Project sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `target_milestone` | string | Yes | The ID of the target milestone |
| `transition_condition` | string | Yes | A transition condition for milestone progression |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change your own password

**Slug:** `UNLEASH_CHANGE_MY_PASSWORD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `password` | string | Yes | The new password. Treat this value as a secret and never log it. |
| `old_password` | string | Yes | The connected user's current password. Treat this value as a secret and never log it. |
| `confirm_password` | string | Yes | Confirmation of the new password. Treat this value as a secret and never log it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move feature to project

**Slug:** `UNLEASH_CHANGE_PROJECT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `new_project_id` | string | Yes | The project to move the feature flag to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create/Add change to a change request

**Slug:** `UNLEASH_CHANGE_REQUEST`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | 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. |
| `project_id` | string | Yes | Project ID in which to create a change request or add a change. |
| `environment` | string | Yes | Environment name where the proposed change will eventually apply. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change password for a user

**Slug:** `UNLEASH_CHANGE_USER_PASSWORD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | a user id |
| `password` | string | Yes | The user's new password. Treat this value as a secret and never log it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check dependencies exist

**Slug:** `UNLEASH_CHECK_DEPENDENCIES_EXIST`

Check if any dependencies exist in this Unleash instance

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validates the Unleash license

**Slug:** `UNLEASH_CHECK_LICENSE`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clones an environment

**Slug:** `UNLEASH_CLONE_ENVIRONMENT`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clone a feature flag

**Slug:** `UNLEASH_CLONE_FEATURE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the new feature |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `replace_group_id` | boolean | No | Whether to use the new feature name as its group ID or not. Group ID is used for calculating [stickiness](https://docs.getunleash.io/concepts/stickiness#calculation). Defaults to true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] Create an action set

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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new addon

**Slug:** `UNLEASH_CREATE_ADDON`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | 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. |
| `events` | array | Yes | Event types to deliver. Use LIST_ADDONS to discover those supported by the selected provider. |
| `api_key` | string | No | Datadog API key. Required for the datadog provider; never log it. |
| `enabled` | boolean | Yes | Whether to begin delivering selected events as soon as the addon is created. |
| `projects` | array | No | Project IDs to deliver events from. Omit or pass an empty list for all projects. |
| `provider` | string | Yes | Case-sensitive addon provider name returned by LIST_ADDONS. Providers are instance-discovered and may include custom integrations. |
| `username` | string | No | Slack webhook username. Applies only to the slack provider and defaults to "Unleash". |
| `emoji_icon` | string | No | Slack webhook emoji icon. Applies only to the slack provider and defaults to ":unleash:". |
| `description` | string | No | Human-readable addon description. |
| `license_key` | string | No | New Relic license key. Required for the new-relic provider; never log it. |
| `access_token` | string | No | App for Slack access token. Required for the slack-app provider; never log it. |
| `content_type` | string | No | Webhook Content-Type header. Applies only to the webhook provider and defaults to application/json. |
| `environments` | array | No | Environment names to deliver events from. Omit or pass an empty list for all environments. |
| `body_template` | string | No | Mustache body template for webhook, Datadog, or New Relic delivery. |
| `custom_headers` | object | No | 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. |
| `default_channel` | string | No | Fallback Slack channel when an event has no Slack tag. Required for the slack provider. |
| `default_channels` | array | No | Slack App channels that always receive selected events, in addition to channels selected by Slack tags. |
| `source_type_name` | string | No | Datadog event source_type_name. Applies only to the datadog provider. |
| `provider_parameters` | object | No | 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. |
| `webhook_header_value` | string | No | Value Unleash sends in the webhook Authorization header. Applies only to the webhook provider; never log it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create API token

**Slug:** `UNLEASH_CREATE_API_TOKEN`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create an application to connect reported metrics

**Slug:** `UNLEASH_CREATE_APPLICATION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | A link to reference the application reporting the metrics. Could for instance be a GitHub link to the repository of the application |
| `icon` | string | No | An URL to an icon file to be used for the applications's entry in the application list |
| `color` | string | No | Css color to be used to color the application's entry in the application list |
| `app_name` | string | Yes | App Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `strategies` | array | No | Which [strategies](https://docs.getunleash.io/concepts#activation-strategies) the application has loaded. Useful when trying to figure out if your [custom strategy](https://docs.getunleash.io/concepts/activation-strategies#custom-strategies) has been loaded in the SDK |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a banner

**Slug:** `UNLEASH_CREATE_BANNER`

Creates a new banner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `icon` | string | No | 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. |
| `link` | string | No | 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. |
| `dialog` | string | No | The markdown to display on the dialog. If not specified, no dialog will be displayed. |
| `sticky` | boolean | No | Whether the banner should be sticky on the screen. If not specified, defaults to `false`. |
| `enabled` | boolean | No | Whether the banner should be displayed currently. If not specified, defaults to true. |
| `message` | string | Yes | The message to display to all users. Supports markdown. |
| `variant` | string ("info" | "warning" | "error" | "success") | No | The variant of the banner. One of "info", "warning", "error", or "success". If not specified, defaults to "info". |
| `link_text` | string | No | The text to display on the link. If not specified, will be displayed as "More info". |
| `dialog_title` | string | No | The title to display on the dialog. If not specified, this will be the same as `linkText`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Context Field

**Slug:** `UNLEASH_CREATE_CONTEXT_FIELD`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Creates a new environment

**Slug:** `UNLEASH_CREATE_ENVIRONMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the environment. Must be a URL-friendly string according to [RFC 3968, section 2.3](https://www.rfc-editor.org/rfc/rfc3986#section-2.3) |
| `type` | string | Yes | The [type of environment](https://docs.getunleash.io/concepts/environments#environment-types) 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. |
| `enabled` | boolean | No | Newly created environments are enabled by default. Set this property to `false` to create the environment in a disabled state. |
| `sort_order` | integer | No | 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. |
| `required_approvals` | integer | No | Experimental field. The number of approvals required before a change request can be applied in this environment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Feature

**Slug:** `UNLEASH_CREATE_FEATURE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique feature flag name. |
| `tags` | array | No | Tags to attach to the feature at creation time. |
| `type` | string ("experiment" | "kill-switch" | "release" | "operational" | "permission" | "sunset") | No | Feature flag type. |
| `project_id` | string | Yes | Project ID that will contain the feature flag. |
| `description` | string | No | Detailed feature description. |
| `impression_data` | boolean | No | Whether to collect impression data for the feature. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a feature link

**Slug:** `UNLEASH_CREATE_FEATURE_LINK`

Create a new link for a feature.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL the feature is linked to |
| `title` | string | No | The description of the link |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new group

**Slug:** `UNLEASH_CREATE_GROUP`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the group |
| `users` | array | No | A list of users belonging to this group |
| `root_role` | integer ("1" | "2" | "3") | No | Predefined root role ID applied to all group members: 1 (Admin), 2 (Editor), or 3 (Viewer). |
| `description` | string | No | A custom description of the group |
| `mappings_sso` | array | No | A list of SSO groups that should map to this Unleash group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

**Slug:** `UNLEASH_CREATE_PAT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expires_at` | string | Yes | The PAT's expiration date. |
| `description` | string | Yes | The PAT's description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create project

**Slug:** `UNLEASH_CREATE_PROJECT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | 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. |
| `mode` | string ("open" | "protected" | "private") | No | A mode of the project affecting what actions are possible in this project |
| `name` | string | Yes | The project's name. The name must contain at least one non-whitespace character. |
| `description` | string | No | The project's description. |
| `environments` | array | No | 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. |
| `default_stickiness` | string | No | A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy |
| `change_request_environments` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a project API token

**Slug:** `UNLEASH_CREATE_PROJECT_API_TOKEN`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a public signup token

**Slug:** `UNLEASH_CREATE_PUBLIC_SIGNUP_TOKEN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The token's name. |
| `expires_at` | string | Yes | The token's expiration date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a release template

**Slug:** `UNLEASH_CREATE_RELEASE_TEMPLATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The release template's name. |
| `scope` | string ("global" | "project") | Yes | Whether to create a global template or a template for one project. The project-scoped API is beta. |
| `milestones` | array | No | Milestones to include in the release template. |
| `project_id` | string | No | Project ID. Required only when scope is `project` and forbidden for `global`. |
| `description` | string | No | The release template's description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new role

**Slug:** `UNLEASH_CREATE_ROLE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the new custom role. |
| `type` | string ("root-custom" | "custom") | No | Role scope: "root-custom" applies across the instance; "custom" is a project role. |
| `description` | string | No | What the custom role is intended for. |
| `permissions` | array | No | Permissions assigned to the role, identified consistently by permission name or numeric permission ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Segment

**Slug:** `UNLEASH_CREATE_SEGMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Segment name. |
| `project` | string | No | Project ID that owns the segment, or omit for a global segment. |
| `constraints` | array | Yes | Complete list of constraints that define the segment. |
| `description` | string | No | What this segment represents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a service account

**Slug:** `UNLEASH_CREATE_SERVICE_ACCOUNT`

Creates a new service account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the service account |
| `username` | string | Yes | The username of the service account |
| `root_role` | integer | Yes | The id of the root role for the service account |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a token for a service account

**Slug:** `UNLEASH_CREATE_SERVICE_ACCOUNT_TOKEN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `expires_at` | string | Yes | The PAT's expiration date. |
| `description` | string | Yes | The PAT's description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] Create a signal endpoint

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The signal endpoint name. Must be URL-safe. |
| `enabled` | boolean | No | Whether the signal endpoint is currently enabled. If not specified, defaults to true. |
| `description` | string | No | A more detailed description of the signal endpoint and its intended use. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The signal endpoint token name. |
| `signal_endpoint_id` | string | Yes | Signal Endpoint Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a strategy

**Slug:** `UNLEASH_CREATE_STRATEGY`

Creates a custom strategy type based on the supplied data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the strategy type. Must be unique. |
| `title` | string | No | The title of the strategy |
| `editable` | boolean | No | Whether the strategy type is editable or not. Defaults to `true`. |
| `deprecated` | boolean | No | Whether the strategy type is deprecated or not. Defaults to `false`. |
| `parameters` | array | Yes | The parameter list lets you pass arguments to your custom activation strategy. These will be made available to your custom strategy implementation. |
| `description` | string | No | A description of the strategy type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new tag

**Slug:** `UNLEASH_CREATE_TAG`

Create a new tag with the specified data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | The [type](https://docs.getunleash.io/concepts/feature-flags#tags) of the tag |
| `color` | string | No | The hexadecimal color code for the tag type. |
| `value` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a tag type

**Slug:** `UNLEASH_CREATE_TAG_TYPE`

Create a new tag type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `icon` | string | No | The icon of the tag type. |
| `name` | string | Yes | The name of the tag type. |
| `color` | string | No | The hexadecimal color code for the tag type. |
| `description` | string | No | The description of the tag type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new user

**Slug:** `UNLEASH_CREATE_USER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The user's name (not the user's username). |
| `email` | string | No | The user's email address. Must be provided if username is not provided. |
| `password` | string | No | Password for the user. Treat this value as a secret and never log it. |
| `username` | string | No | The user's username. Must be provided if email is not provided. |
| `root_role` | string | Yes | The role to assign to the user. Can be either the role's ID or its unique name. |
| `send_email` | boolean | No | Whether to send a welcome email with a login link to the user or not. Defaults to `true`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] Delete an action set

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an addon

**Slug:** `UNLEASH_DELETE_ADDON`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an application

**Slug:** `UNLEASH_DELETE_APPLICATION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_name` | string | Yes | App Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a banner

**Slug:** `UNLEASH_DELETE_BANNER`

Deletes an existing banner identified by its id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Discards a change from a change request by change id

**Slug:** `UNLEASH_DELETE_CHANGE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `change_id` | string | Yes | Change Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `change_request_id` | string | Yes | Change Request Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deletes a change request by id

**Slug:** `UNLEASH_DELETE_CHANGE_REQUEST`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Context Field

**Slug:** `UNLEASH_DELETE_CONTEXT_FIELD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("root" | "project") | Yes | Use root context fields or the beta context fields for one project. |
| `project_id` | string | No | Project ID. Required only when scope is project. |
| `context_field` | string | Yes | Exact name of the context field to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Context Field Legal Value

**Slug:** `UNLEASH_DELETE_CONTEXT_FIELD_LEGAL_VALUE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("root" | "project") | Yes | Use root context fields or the beta context fields for one project. |
| `project_id` | string | No | Project ID. Required only when scope is project. |
| `legal_value` | string | Yes | Exact legal value to permanently delete. |
| `context_field` | string | Yes | Exact name of the context field whose legal value is deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an environment

**Slug:** `UNLEASH_DELETE_ENVIRONMENT`

Delete an environment identified by name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deletes an archived feature

**Slug:** `UNLEASH_DELETE_FEATURE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete feature dependencies

**Slug:** `UNLEASH_DELETE_FEATURE_DEPENDENCIES`

Remove all parent feature dependencies from one child feature flag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID containing the child feature flag. |
| `child_feature_name` | string | Yes | Exact child feature flag name whose parent dependencies will all be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a feature dependency

**Slug:** `UNLEASH_DELETE_FEATURE_DEPENDENCY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID containing the child and parent feature flags. |
| `child_feature_name` | string | Yes | Exact child feature flag name from which the dependency will be removed. |
| `parent_feature_name` | string | Yes | Exact parent feature flag name to remove from the child's dependencies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a feature link

**Slug:** `UNLEASH_DELETE_FEATURE_LINK`

Delete a feature link by id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link_id` | string | Yes | Link Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deletes a list of features

**Slug:** `UNLEASH_DELETE_FEATURES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `features` | array | Yes | List of feature flag names |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Feature Strategy

**Slug:** `UNLEASH_DELETE_FEATURE_STRATEGY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID containing the feature flag. |
| `environment` | string | Yes | Environment name, such as development or production. |
| `strategy_id` | string | Yes | Strategy instance ID returned by Get Feature Environment. |
| `feature_name` | string | Yes | Exact feature flag name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a single group

**Slug:** `UNLEASH_DELETE_GROUP`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | Group Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete impact metric configuration

**Slug:** `UNLEASH_DELETE_IMPACT_METRIC_CONFIG`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target` | string ("instance" | "feature") | Yes | Configuration target: instance or feature. |
| `config_id` | string | Yes | ULID of the impact metric configuration to permanently delete from the selected target. |
| `project_id` | string | No | Project ID containing the feature flag. Required only when target is feature. |
| `feature_name` | string | No | Exact feature flag name. Required only when target is feature. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deletes inactive users

**Slug:** `UNLEASH_DELETE_INACTIVE_USERS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | Yes | IDs of inactive users to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a milestone progression

**Slug:** `UNLEASH_DELETE_MILESTONE_PROGRESSION`

Deletes an existing milestone progression by source milestone ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project` | string | Yes | Project sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

**Slug:** `UNLEASH_DELETE_PAT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pat_id` | integer | Yes | Numeric personal access token ID returned by the PAT listing action; this is not the token secret. |
| `confirm_not_current_connection_credential` | boolean | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete project

**Slug:** `UNLEASH_DELETE_PROJECT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a release plan

**Slug:** `UNLEASH_DELETE_RELEASE_PLAN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `plan_id` | string | Yes | Plan Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project` | string | Yes | Project sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a release template

**Slug:** `UNLEASH_DELETE_RELEASE_TEMPLATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("global" | "project") | Yes | Whether to delete a global template or a template for one project. The project-scoped API is beta. |
| `project_id` | string | No | Project ID. Required only when scope is `project` and forbidden for `global`. |
| `template_id` | string | Yes | ID of the release template to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a custom role

**Slug:** `UNLEASH_DELETE_ROLE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_id` | string | Yes | Role Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete safeguard

**Slug:** `UNLEASH_DELETE_SAFEGUARD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target` | string ("feature_environment" | "release_plan") | Yes | Safeguard target: the feature environment itself or one release plan. |
| `plan_id` | string | No | Release plan ID. Required only when target is release_plan. |
| `project_id` | string | Yes | Project ID containing the feature flag. |
| `environment` | string | Yes | Environment name containing the safeguard. |
| `feature_name` | string | Yes | Exact feature flag name. |
| `safeguard_id` | string | Yes | ID of the safeguard to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete all SCIM groups

**Slug:** `UNLEASH_DELETE_SCIM_GROUPS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete all SCIM users

**Slug:** `UNLEASH_DELETE_SCIM_USERS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Segment

**Slug:** `UNLEASH_DELETE_SEGMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | integer | Yes | Numeric segment ID returned by List Segments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a service account

**Slug:** `UNLEASH_DELETE_SERVICE_ACCOUNT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a token for a service account

**Slug:** `UNLEASH_DELETE_SERVICE_ACCOUNT_TOKEN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token_id` | string | Yes | Service account token ID returned by the token listing action; this is not the token secret. |
| `service_account_id` | string | Yes | Service account ID that owns the token. |
| `confirm_not_current_connection_credential` | boolean | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] Delete a signal endpoint

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] Delete a signal endpoint token

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `signal_endpoint_id` | string | Yes | Signal Endpoint Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a strategy

**Slug:** `UNLEASH_DELETE_STRATEGY`

Deletes the specified strategy definition

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a tag

**Slug:** `UNLEASH_DELETE_TAG`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | Type sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `value` | string | Yes | Value sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a tag type

**Slug:** `UNLEASH_DELETE_TAG_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a user

**Slug:** `UNLEASH_DELETE_USER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | a user id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] Disconnect all clients

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export feature flags from an environment

**Slug:** `UNLEASH_EXPORT_FEATURES`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generates a new SCIM API token

**Slug:** `UNLEASH_GENERATE_SCIM_TOKEN`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Gets access overview

**Slug:** `UNLEASH_GET_ACCESS_OVERVIEW`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the number of change requests you can do something with

**Slug:** `UNLEASH_GET_ACTIONABLE_CHANGE_REQUESTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a specific addon

**Slug:** `UNLEASH_GET_ADDON`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get total count of admin accounts

**Slug:** `UNLEASH_GET_ADMIN_COUNT`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch evaluate an Unleash context against a set of environments and projects

**Slug:** `UNLEASH_GET_ADVANCED_PLAYGROUND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `context` | object | Yes | The Unleash context as modeled in client SDKs |
| `projects` | string | No | A list of projects to check for toggles in. |
| `environments` | array | Yes | The environments to evaluate toggles in. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get application data

**Slug:** `UNLEASH_GET_APPLICATION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_name` | string | Yes | App Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get application environment instances (Last 24h)

**Slug:** `UNLEASH_GET_APPLICATION_ENVIRONMENT_INSTANCES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_name` | string | Yes | App Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get application overview

**Slug:** `UNLEASH_GET_APPLICATION_OVERVIEW`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_name` | string | Yes | App Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get basic user and group information

**Slug:** `UNLEASH_GET_BASE_USERS_AND_GROUPS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieves one change request by id

**Slug:** `UNLEASH_GET_CHANGE_REQUEST`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Evaluate an Unleash context against a change request preview

**Slug:** `UNLEASH_GET_CHANGE_REQUEST_PLAYGROUND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `context` | object | Yes | The Unleash context as modeled in client SDKs |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieves number of project change requests in each state

**Slug:** `UNLEASH_GET_CHANGE_REQUESTS_COUNT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] Get aggregated metered connections for a given time period

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | Yes | The starting date of the traffic data usage search in IS:yyyy-MM-dd format |
| `from` | string | Yes | The starting date of the traffic data usage search in IS:yyyy-MM-dd format |
| `grouping` | string ("daily" | "monthly") | Yes | Whether to aggregate the data by month or by day |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Context Field

**Slug:** `UNLEASH_GET_CONTEXT_FIELD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("root" | "project") | Yes | Use root context fields or the beta context fields for one project. |
| `project_id` | string | No | Project ID. Required only when scope is project. |
| `context_field` | string | Yes | Exact name of the context field to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Detailed Invoices

**Slug:** `UNLEASH_GET_DETAILED_INVOICES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the environment with `name`

**Slug:** `UNLEASH_GET_ENVIRONMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get variants for a feature in an environment

**Slug:** `UNLEASH_GET_ENVIRONMENT_FEATURE_VARIANTS`

Returns 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get the external impact-metrics source

**Slug:** `UNLEASH_GET_EXTERNAL_IMPACT_METRICS_SOURCE`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Feature

**Slug:** `UNLEASH_GET_FEATURE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID containing the feature flag. |
| `feature_name` | string | Yes | Exact feature flag name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Feature Environment

**Slug:** `UNLEASH_GET_FEATURE_ENVIRONMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID containing the feature flag. |
| `environment` | string | Yes | Environment name, such as development or production. |
| `feature_name` | string | Yes | Exact feature flag name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get feature lifecycle

**Slug:** `UNLEASH_GET_FEATURE_LIFECYCLE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get feature flag strategies

**Slug:** `UNLEASH_GET_FEATURE_STRATEGIES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a strategy configuration

**Slug:** `UNLEASH_GET_FEATURE_STRATEGY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `strategy_id` | string | Yes | Strategy Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Last hour of usage and a list of applications that have reported seeing this feature flag

**Slug:** `UNLEASH_GET_FEATURE_USAGE_SUMMARY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `feature_name` | string | Yes | Exact feature flag name whose usage summary should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single group

**Slug:** `UNLEASH_GET_GROUP`

Get a single user group by group id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | Group Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instance usage statistics

**Slug:** `UNLEASH_GET_INSTANCE_ADMIN_STATS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Instance usage statistics

**Slug:** `UNLEASH_GET_INSTANCE_ADMIN_STATS_CSV`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get instance information

**Slug:** `UNLEASH_GET_INSTANCE_INSIGHTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | The end of the date range in yyyy-MM-dd format |
| `from_value` | string | No | The beginning of the date range in yyyy-MM-dd format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get licensed user statistics

**Slug:** `UNLEASH_GET_LICENSED_USER_STATS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get lifecycle trends

**Slug:** `UNLEASH_GET_LIFECYCLE_TRENDS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projects` | string | No | Comma-separated list of project IDs to filter lifecycle trends |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get maintenance mode status

**Slug:** `UNLEASH_GET_MAINTENANCE`

Tells you whether maintenance mode is enabled or disabled

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get your own user details

**Slug:** `UNLEASH_GET_ME`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get OIDC auth settings

**Slug:** `UNLEASH_GET_OIDC_SETTINGS`

Returns the current settings for OIDC Authentication.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieves pending change requests in configured environments

**Slug:** `UNLEASH_GET_PENDING_CHANGE_REQUESTS_FOR_USER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Plausible analytics data

**Slug:** `UNLEASH_GET_PLAUSIBLE_METRICS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get your own user profile

**Slug:** `UNLEASH_GET_PROFILE`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get users and groups in project

**Slug:** `UNLEASH_GET_PROJECT_ACCESS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get api tokens for project

**Slug:** `UNLEASH_GET_PROJECT_API_TOKENS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieves change request configuration for a project

**Slug:** `UNLEASH_GET_PROJECT_CHANGE_REQUEST_CONFIG`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get an overview of a project

**Slug:** `UNLEASH_GET_PROJECT_OVERVIEW`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get project status

**Slug:** `UNLEASH_GET_PROJECT_STATUS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get feature metrics

**Slug:** `UNLEASH_GET_RAW_FEATURE_METRICS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `feature_name` | string | Yes | Exact feature flag name whose hourly usage metrics should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a release template

**Slug:** `UNLEASH_GET_RELEASE_TEMPLATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("global" | "project") | Yes | Whether to read a global template or a template for one project. The project-scoped API is beta. |
| `project_id` | string | No | Project ID. Required only when scope is `project` and forbidden for `global`. |
| `template_id` | string | Yes | ID of the release template to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get remote MCP server settings

**Slug:** `UNLEASH_GET_REMOTE_MCP_SETTINGS`

Returns the current settings for the remote MCP server.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] Get aggregated metered requests for a given time period

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | Yes | The starting date of the traffic data usage search in IS:yyyy-MM-dd format |
| `from` | string | Yes | The starting date of the traffic data usage search in IS:yyyy-MM-dd format |
| `grouping` | string ("daily" | "monthly") | Yes | Whether to aggregate the data by month or by day |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Gets usage data

**Slug:** `UNLEASH_GET_REQUESTS_PER_SECOND`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a single role

**Slug:** `UNLEASH_GET_ROLE_BY_ID`

Get a single role by role id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_id` | string | Yes | Role Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get project-role mappings

**Slug:** `UNLEASH_GET_ROLE_PROJECT_ACCESS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_id` | string | Yes | Role Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SAML auth settings

**Slug:** `UNLEASH_GET_SAML_SETTINGS`

Returns the current settings for SAML authentication.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get scheduled change requests matching a query

**Slug:** `UNLEASH_GET_SCHEDULED_CHANGE_REQUESTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `feature` | string | No | Exact feature flag name touched by a scheduled change request. |
| `project_id` | string | Yes | Project ID containing the scheduled change requests. |
| `strategy_id` | string | No | Exact activation strategy ID touched by a scheduled change request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SCIM settings

**Slug:** `UNLEASH_GET_SCIM_SETTINGS`

Returns the current settings for SCIM provisioning.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segment

**Slug:** `UNLEASH_GET_SEGMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | integer | Yes | Numeric segment ID returned by List Segments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Returns the list of permissions for the service account

**Slug:** `UNLEASH_GET_SERVICE_ACCOUNT_PERMISSIONS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project` | string | No | Project sent in the request query. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | No | Environment sent in the request query. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Simple auth settings

**Slug:** `UNLEASH_GET_SIMPLE_SETTINGS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get strategies that use a context field

**Slug:** `UNLEASH_GET_STRATEGIES_BY_CONTEXT_FIELD`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a strategy definition

**Slug:** `UNLEASH_GET_STRATEGY`

Retrieves the definition of the strategy specified in the URL

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a tag by type and value

**Slug:** `UNLEASH_GET_TAG`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | Type sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `value` | string | Yes | Value sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a tag type

**Slug:** `UNLEASH_GET_TAG_TYPE`

Get a tag type by name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get telemetry settings

**Slug:** `UNLEASH_GET_TELEMETRY_SETTINGS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get aggregated traffic data for a given time period

**Slug:** `UNLEASH_GET_TRAFFIC_DATA_USAGE_FOR_PERIOD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | Yes | The starting date of the traffic data usage search in IS:yyyy-MM-dd format |
| `from` | string | Yes | The starting date of the traffic data usage search in IS:yyyy-MM-dd format |
| `grouping` | string ("daily" | "monthly") | Yes | Whether to aggregate the data by month or by day |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get user

**Slug:** `UNLEASH_GET_USER`

Will return a single user by id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | a user id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import feature flags

**Slug:** `UNLEASH_IMPORT_TOGGLES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | 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.) |
| `project` | string | Yes | The exported [project](https://docs.getunleash.io/concepts/projects) |
| `environment` | string | Yes | The exported [environment](https://docs.getunleash.io/concepts/environments) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] List events for an action set

**Slug:** `UNLEASH_LIST_ACTION_SET_EVENTS`

**[BETA]** This API is in beta state, which means it may change or be removed in the future. Returns a list of action events triggered by a specific action set, identified by its id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `limit` | integer | No | The number of results to return in a page. By default it is set to 50. |
| `cursor` | string | No | Continuation cursor returned by the previous call. Pass it unchanged to fetch the next page. |
| `offset` | integer | No | The number of results to skip on the first page. Defaults to 0. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] List action sets

**Slug:** `UNLEASH_LIST_ACTION_SETS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all addons and providers

**Slug:** `UNLEASH_LIST_ADDONS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all environments

**Slug:** `UNLEASH_LIST_ALL_ENVIRONMENTS`

Retrieves all environments that exist in this Unleash instance.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all feature types

**Slug:** `UNLEASH_LIST_ALL_FEATURE_TYPES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List API tokens

**Slug:** `UNLEASH_LIST_API_TOKENS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List API tokens by name

**Slug:** `UNLEASH_LIST_API_TOKENS_BY_NAME`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all applications

**Slug:** `UNLEASH_LIST_APPLICATIONS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List available change request reviewers

**Slug:** `UNLEASH_LIST_AVAILABLE_CHANGE_REQUEST_REVIEWERS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List available impact metrics

**Slug:** `UNLEASH_LIST_AVAILABLE_IMPACT_METRICS`

Returns all available impact metrics and their metadata.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all banners

**Slug:** `UNLEASH_LIST_BANNERS`

Returns a list of all configured banners.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List requested change request reviewers

**Slug:** `UNLEASH_LIST_CHANGE_REQUEST_REVIEWERS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Change request ID returned by a change-request read or search action. |
| `project_id` | string | Yes | Project ID containing the change request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List change requests for a project

**Slug:** `UNLEASH_LIST_CHANGE_REQUESTS_FOR_PROJECT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Context Fields

**Slug:** `UNLEASH_LIST_CONTEXT_FIELDS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("root" | "project") | Yes | Use root context fields or the beta context fields for one project. |
| `project_id` | string | No | Project ID. Required only when scope is project. |
| `include_other_scope` | boolean | No | Also return project fields when scope is root, or root fields when scope is project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of all users that have created events

**Slug:** `UNLEASH_LIST_EVENT_CREATORS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all features lifecycle stage count

**Slug:** `UNLEASH_LIST_FEATURE_LIFECYCLE_STAGE_COUNT`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Features

**Slug:** `UNLEASH_LIST_FEATURES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID containing the feature flags. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all tags for a feature

**Slug:** `UNLEASH_LIST_FEATURE_TAGS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of groups

**Slug:** `UNLEASH_LIST_GROUPS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List impact metric configurations

**Slug:** `UNLEASH_LIST_IMPACT_METRIC_CONFIGS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target` | string ("instance" | "feature") | Yes | Configuration target: instance for charts not associated with a feature flag, or feature for one feature flag. |
| `project_id` | string | No | Project ID containing the feature flag. Required only when target is feature. |
| `feature_name` | string | No | Exact feature flag name. Required only when target is feature. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List inactive users

**Slug:** `UNLEASH_LIST_INACTIVE_USERS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List integration events for a specific integration configuration

**Slug:** `UNLEASH_LIST_INTEGRATION_EVENTS`

Returns a list of integration events belonging to a specific integration configuration, identified by its id.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List invoices

**Slug:** `UNLEASH_LIST_INVOICES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all login events

**Slug:** `UNLEASH_LIST_LOGIN_HISTORY`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List notifications

**Slug:** `UNLEASH_LIST_NOTIFICATIONS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List outdated SDKs

**Slug:** `UNLEASH_LIST_OUTDATED_SDKS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("instance" | "project") | Yes | Whether to list outdated SDKs across the instance or in one project. |
| `project_id` | string | No | Project ID. Required only when scope is `project` and forbidden for `instance`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List parent options

**Slug:** `UNLEASH_LIST_PARENT_OPTIONS`

List available parents who have no transitive dependencies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID containing the child feature flag. |
| `child_feature_name` | string | Yes | Exact child feature flag name for which valid parent candidates are requested. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List parent feature variants

**Slug:** `UNLEASH_LIST_PARENT_VARIANT_OPTIONS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID containing the parent feature flag. |
| `parent_feature_name` | string | Yes | Exact parent feature flag name whose available variants will be listed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all personal access tokens (PATs) for the current user

**Slug:** `UNLEASH_LIST_PATS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List pending change requests referencing a feature

**Slug:** `UNLEASH_LIST_PENDING_CHANGE_REQUESTS_FOR_FEATURE`

This 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List available permissions

**Slug:** `UNLEASH_LIST_PERMISSIONS`

Returns a list of available permissions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Project Environments

**Slug:** `UNLEASH_LIST_PROJECT_ENVIRONMENTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project ID containing the feature flag. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of all flag creators for a project

**Slug:** `UNLEASH_LIST_PROJECT_FLAG_CREATORS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `UNLEASH_LIST_PROJECTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `archived` | boolean | No | Whether to include archived projects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List public signup tokens

**Slug:** `UNLEASH_LIST_PUBLIC_SIGNUP_TOKENS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List release plans

**Slug:** `UNLEASH_LIST_RELEASE_PLANS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project` | string | Yes | Project sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List release templates

**Slug:** `UNLEASH_LIST_RELEASE_TEMPLATES`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a list of roles

**Slug:** `UNLEASH_LIST_ROLES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Segments

**Slug:** `UNLEASH_LIST_SEGMENTS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List strategy segments

**Slug:** `UNLEASH_LIST_SEGMENTS_BY_STRATEGY_ID`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `strategy_id` | string | Yes | Strategy Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List service accounts

**Slug:** `UNLEASH_LIST_SERVICE_ACCOUNTS`

Returns the list of all service accounts.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List all tokens for a service account

**Slug:** `UNLEASH_LIST_SERVICE_ACCOUNT_TOKENS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] List signal endpoints

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] List signals from a specific signal endpoint

**Slug:** `UNLEASH_LIST_SIGNAL_ENDPOINT_SIGNALS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] List tokens for a specific signal endpoint

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `signal_endpoint_id` | string | Yes | Signal Endpoint Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] List signals

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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List strategies that reference a segment

**Slug:** `UNLEASH_LIST_STRATEGIES_BY_SEGMENT_ID`

Retrieve all strategies that reference the specified segment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | a segment id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Strategy Types

**Slug:** `UNLEASH_LIST_STRATEGY_TYPES`

List predefined and custom strategy types available for feature configuration.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List all tags

**Slug:** `UNLEASH_LIST_TAGS`

List all tags available in Unleash.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List all tags of a given type

**Slug:** `UNLEASH_LIST_TAGS_BY_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | Type sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all tag types

**Slug:** `UNLEASH_LIST_TAG_TYPES`

Get a list of all available tag types.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List unknown flags

**Slug:** `UNLEASH_LIST_UNKNOWN_FLAGS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all pending user access requests

**Slug:** `UNLEASH_LIST_USER_ACCESS_REQUESTS`

Returns a list of all pending user access requests.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List roles for the currently logged-in user

**Slug:** `UNLEASH_LIST_USER_ROLES`

Gets roles assigned to currently logged in user. Both explicitly and transitively through group memberships.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | The id of the project you want to check permissions for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

**Slug:** `UNLEASH_LIST_USERS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark notifications as read

**Slug:** `UNLEASH_MARK_NOTIFICATIONS_AS_READ`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notifications` | array | Yes | A list of IDs belonging to the notifications you want to mark as read. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create (overwrite) variants for a feature in an environment

**Slug:** `UNLEASH_OVERWRITE_ENVIRONMENT_FEATURE_VARIANTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `variants` | array | Yes | Complete replacement variant list. Pass an empty list to remove all variants from this feature in the environment. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

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

**Slug:** `UNLEASH_OVERWRITE_FEATURE_VARIANTS_ON_ENVIRONMENTS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch a feature's variants in an environment

**Slug:** `UNLEASH_PATCH_ENVIRONMENTS_FEATURE_VARIANTS`

Apply a list of patches to the features environments in the specified environment. The patch objects should conform to the [JSON-patch format (RFC 6902)](https://www.rfc-editor.org/rfc/rfc6902).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `patches` | array | Yes | 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_. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Modify a feature flag

**Slug:** `UNLEASH_PATCH_FEATURE`

Change specific properties of a feature flag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `patches` | array | Yes | 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_. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change specific properties of a strategy

**Slug:** `UNLEASH_PATCH_FEATURE_STRATEGY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `patches` | array | Yes | 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_. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `strategy_id` | string | Yes | Strategy Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query impact metrics time series data

**Slug:** `UNLEASH_QUERY_IMPACT_METRICS_TIME_SERIES`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reads the Unleash license

**Slug:** `UNLEASH_READ_LICENSE`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Register a new impact metric

**Slug:** `UNLEASH_REGISTER_IMPACT_METRIC`

Registers a new impact metric by pushing 0-values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The metric name. Must start with a letter or underscore and contain only alphanumerics, underscores or colons. |
| `type` | string ("counter" | "gauge" | "histogram") | Yes | The type of metric to register. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reject a user access request

**Slug:** `UNLEASH_REJECT_USER_ACCESS_REQUEST`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove an environment from a project

**Slug:** `UNLEASH_REMOVE_ENVIRONMENT_FROM_PROJECT`

This endpoint removes the specified environment from the project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove project access for a group

**Slug:** `UNLEASH_REMOVE_GROUP_ACCESS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | Group Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove project access for a user

**Slug:** `UNLEASH_REMOVE_USER_ACCESS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | User Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate user password-reset URL

**Slug:** `UNLEASH_RESET_USER_PASSWORD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address of the user who needs a password-reset URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resume paused milestone progressions

**Slug:** `UNLEASH_RESUME_MILESTONE_PROGRESSIONS`

Resumes all paused milestone progressions for a release plan

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `plan_id` | string | Yes | Plan Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project` | string | Yes | Project sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revives a feature

**Slug:** `UNLEASH_REVIVE_FEATURE`

This endpoint revives the specified feature from archive.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Revives a list of features

**Slug:** `UNLEASH_REVIVE_FEATURES`

This endpoint revives the specified features.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `features` | array | Yes | List of feature flag names |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Save impact metric configuration

**Slug:** `UNLEASH_SAVE_IMPACT_METRIC_CONFIG`

Create 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search change requests

**Slug:** `UNLEASH_SEARCH_CHANGE_REQUESTS`

Search and filter change requests by creator and approver.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | The number of change requests to return in a page. By default it is set to 50. The maximum is 1000. |
| `state` | string ("IS:open" | "IS:closed") | No | 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. |
| `cursor` | string | No | Continuation cursor returned by the previous call. Pass it unchanged to fetch the next page. |
| `offset` | integer | No | The number of change requests to skip on the first page. Defaults to 0. |
| `created_by` | string | No | Filter by change request creator user ID |
| `requested_approver_id` | string | No | Filter by requested approver user ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search for events

**Slug:** `UNLEASH_SEARCH_EVENTS`

Allows searching for events that match the query parameter criteria.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Features

**Slug:** `UNLEASH_SEARCH_FEATURES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | 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. |
| `type` | string | No | Feature-type filter in OPERATOR:value form. Supported operators are IS, IS_NOT, IS_ANY_OF, and IS_NONE_OF. |
| `limit` | integer | No | Maximum number of features in this page (1-100). |
| `query` | string | No | Text to match against feature names or tags. |
| `state` | string | No | Active or stale filter in OPERATOR:value form. Supported operators are IS, IS_NOT, IS_ANY_OF, and IS_NONE_OF. |
| `cursor` | string | No | Opaque continuation cursor returned by the previous call. Pass it unchanged and omit the other filters when continuing. |
| `status` | array | No | Environment status filters as environment:status values. |
| `project` | string | No | Project filter in OPERATOR:value form. Supported operators are IS, IS_NOT, IS_ANY_OF, and IS_NONE_OF. |
| `segment` | string | No | Segment filter in OPERATOR:value form using the tag-filter operators. |
| `sort_by` | string | No | Provider field used to sort results. |
| `favorite` | string | No | Favorite filter, such as IS:true or IS_ANY_OF:true,false. |
| `lifecycle` | string | No | Lifecycle-stage filter in OPERATOR:value form. Supported operators are IS, IS_NOT, IS_ANY_OF, and IS_NONE_OF. |
| `created_at` | string | No | Creation-date filter as IS_BEFORE:YYYY-MM-DD or IS_ON_OR_AFTER:YYYY-MM-DD. |
| `created_by` | string | No | Creator filter in OPERATOR:value form. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction. |
| `last_seen_at` | string | No | Last-seen filter as IS_BEFORE:YYYY-MM-DD or IS_ON_OR_AFTER:YYYY-MM-DD. |
| `favorites_first` | boolean | No | Whether favorite flags should sort first. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search users

**Slug:** `UNLEASH_SEARCH_USERS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | The pattern to search in the username or email |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Action Set State

**Slug:** `UNLEASH_SET_ACTION_SET_STATE`

Enable or disable one project action set.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `enabled` | boolean | Yes | True for the positive state; false for the inverse state. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Banner State

**Slug:** `UNLEASH_SET_BANNER_STATE`

Enable or disable an instance banner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `enabled` | boolean | Yes | True for the positive state; false for the inverse state. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set change request reviewers

**Slug:** `UNLEASH_SET_CHANGE_REQUEST_REVIEWERS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Change request ID returned by a change-request read or search action. |
| `reviewers` | array | Yes | 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. |
| `project_id` | string | Yes | Project ID containing the change request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sets allowed CORS origins

**Slug:** `UNLEASH_SET_CORS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `frontend_api_origins` | array | No | The list of origins that the front-end API should accept requests from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Email Subscription

**Slug:** `UNLEASH_SET_EMAIL_SUBSCRIPTION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subscribed` | boolean | Yes | True for the positive state; false for the inverse state. |
| `subscription` | string | Yes | Subscription sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Environment State

**Slug:** `UNLEASH_SET_ENVIRONMENT_STATE`

Enable or disable an environment across the Unleash instance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `enabled` | boolean | Yes | True for the positive state; false for the inverse state. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set the external impact-metrics source

**Slug:** `UNLEASH_SET_EXTERNAL_IMPACT_METRICS_SOURCE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | 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. |
| `enabled` | boolean | Yes | Whether the external impact-metrics source is active. When `true`, `url` must be a valid non-empty URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Feature Environment State

**Slug:** `UNLEASH_SET_FEATURE_ENVIRONMENT_STATE`

Enable or disable one feature flag in one environment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | Yes | True to enable the feature flag in the environment; false to disable it. |
| `project_id` | string | Yes | Project ID containing the feature flag. |
| `environment` | string | Yes | Environment name, such as development or production. |
| `feature_name` | string | Yes | Exact feature flag name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Feature Favorite

**Slug:** `UNLEASH_SET_FEATURE_FAVORITE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `favorite` | boolean | Yes | True for the positive state; false for the inverse state. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Feature Lifecycle Completion

**Slug:** `UNLEASH_SET_FEATURE_LIFECYCLE_COMPLETION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("kept" | "discarded") | No | Required when completed is true: final outcome. |
| `completed` | boolean | Yes | True to complete the lifecycle; false to mark it incomplete. |
| `project_id` | string | Yes | Project ID containing the feature flag. |
| `feature_name` | string | Yes | Exact feature flag name. |
| `status_value` | string | No | Optional metadata associated with the completion outcome. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Features Environment State

**Slug:** `UNLEASH_SET_FEATURES_ENVIRONMENT_STATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | Yes | True for the positive state; false for the inverse state. |
| `features` | array | Yes | The features that we want to bulk toggle |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark features as stale / not stale

**Slug:** `UNLEASH_SET_FEATURES_STALE_STATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stale` | boolean | Yes | 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. |
| `features` | array | Yes | A list of features to mark as (not) stale |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enable or disable maintenance mode

**Slug:** `UNLEASH_SET_MAINTENANCE_STATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | Yes | Set true to enable instance-wide maintenance mode and block users from changing configuration. Set false to disable it and restore configuration writes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set OIDC settings

**Slug:** `UNLEASH_SET_OIDC_SETTINGS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set users and groups to roles in the current project

**Slug:** `UNLEASH_SET_PROJECT_ACCESS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `roles` | array | Yes | Complete replacement mapping of project role IDs to assigned user and group IDs. An empty roles list removes all project access assignments. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Project Archived

**Slug:** `UNLEASH_SET_PROJECT_ARCHIVED`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `archived` | boolean | Yes | True for the positive state; false for the inverse state. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Project Favorite

**Slug:** `UNLEASH_SET_PROJECT_FAVORITE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `favorite` | boolean | Yes | True for the positive state; false for the inverse state. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toggle remote MCP server settings

**Slug:** `UNLEASH_SET_REMOTE_MCP_STATE`

Toggles the remote MCP server for this Unleash instance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | Yes | Whether the remote MCP server is currently enabled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sets roles for group

**Slug:** `UNLEASH_SET_ROLES_FOR_GROUP`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `roles` | array | Yes | Complete desired list of project role IDs. This replaces the group's project roles; an empty list removes them all. |
| `group_id` | string | Yes | Numeric group ID returned by an Unleash group or project-access action. |
| `project_id` | string | Yes | Project ID whose group role assignments will be replaced. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sets roles for user

**Slug:** `UNLEASH_SET_ROLES_FOR_USER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `roles` | array | Yes | Complete desired list of project role IDs. This replaces the user's direct project roles; an empty list removes them all. |
| `user_id` | string | Yes | Numeric user ID returned by an Unleash user or project-access action. |
| `project_id` | string | Yes | Project ID whose direct user role assignments will be replaced. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update SAML auth settings

**Slug:** `UNLEASH_SET_SAML_SETTINGS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set SCIM settings

**Slug:** `UNLEASH_SET_SCIM_SETTINGS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | Yes | Whether SCIM provisioning is currently enabled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Signal Endpoint State

**Slug:** `UNLEASH_SET_SIGNAL_ENDPOINT_STATE`

Enable or disable one outbound signal endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `enabled` | boolean | Yes | True for the positive state; false for the inverse state. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Simple auth settings

**Slug:** `UNLEASH_SET_SIMPLE_SETTINGS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `disabled` | boolean | No | Is username/password authentication disabled |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Strategy Deprecated

**Slug:** `UNLEASH_SET_STRATEGY_DEPRECATED`

Deprecate or reactivate one custom strategy type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deprecated` | boolean | Yes | True for the positive state; false for the inverse state. |
| `strategy_name` | string | Yes | Strategy Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set strategy sort order

**Slug:** `UNLEASH_SET_STRATEGY_SORT_ORDER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `strategy_order` | array | Yes | Complete ordered list of strategy instance IDs and their numeric sort orders. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start a release plan milestone

**Slug:** `UNLEASH_START_MILESTONE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `plan_id` | string | Yes | Plan Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project` | string | Yes | Project sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `milestone_id` | string | Yes | Milestone Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] Update an action set

**Slug:** `UNLEASH_UPDATE_ACTION_SET`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an addon

**Slug:** `UNLEASH_UPDATE_ADDON`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique ID of the addon to update. |
| `url` | string | No | 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. |
| `events` | array | Yes | Complete replacement event-type filter. Pass an empty list to select no events. |
| `api_key` | string | No | Datadog API key. Required for the datadog provider; never log it. |
| `enabled` | boolean | Yes | Whether future selected events should be delivered. |
| `projects` | array | Yes | Complete replacement project filter. Pass an empty list for all projects. |
| `provider` | string | Yes | Complete case-sensitive addon provider returned by LIST_ADDONS. |
| `username` | string | No | Slack webhook username. Applies only to the slack provider and defaults to "Unleash". |
| `emoji_icon` | string | No | Slack webhook emoji icon. Applies only to the slack provider and defaults to ":unleash:". |
| `description` | string | Yes | Complete addon description. Pass null to clear it to an empty string. |
| `license_key` | string | No | New Relic license key. Required for the new-relic provider; never log it. |
| `access_token` | string | No | App for Slack access token. Required for the slack-app provider; never log it. |
| `content_type` | string | No | Webhook Content-Type header. Applies only to the webhook provider and defaults to application/json. |
| `environments` | array | Yes | Complete replacement environment filter. Pass an empty list for all environments. |
| `body_template` | string | No | Mustache body template for webhook, Datadog, or New Relic delivery. |
| `custom_headers` | object | No | 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. |
| `default_channel` | string | No | Fallback Slack channel when an event has no Slack tag. Required for the slack provider. |
| `default_channels` | array | No | Slack App channels that always receive selected events, in addition to channels selected by Slack tags. |
| `source_type_name` | string | No | Datadog event source_type_name. Applies only to the datadog provider. |
| `provider_parameters` | object | No | 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. |
| `webhook_header_value` | string | No | Value Unleash sends in the webhook Authorization header. Applies only to the webhook provider; never log it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a banner

**Slug:** `UNLEASH_UPDATE_BANNER`

Updates an existing banner identified by its id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `icon` | string | No | 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. |
| `link` | string | No | 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. |
| `dialog` | string | No | The markdown to display on the dialog. If not specified, no dialog will be displayed. |
| `sticky` | boolean | No | Whether the banner should be sticky on the screen. If not specified, defaults to `false`. |
| `enabled` | boolean | No | Whether the banner should be displayed currently. If not specified, defaults to true. |
| `message` | string | Yes | The message to display to all users. Supports markdown. |
| `variant` | string ("info" | "warning" | "error" | "success") | No | The variant of the banner. One of "info", "warning", "error", or "success". If not specified, defaults to "info". |
| `link_text` | string | No | The text to display on the link. If not specified, will be displayed as "More info". |
| `dialog_title` | string | No | The title to display on the dialog. If not specified, this will be the same as `linkText`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edits a single change in a change request

**Slug:** `UNLEASH_UPDATE_CHANGE_REQUEST_CHANGE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | 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. |
| `change_id` | string | Yes | Current change ID from the latest change-request representation. Replacement invalidates this ID, so read the returned request before another edit. |
| `project_id` | string | Yes | Project ID containing the change request. |
| `change_request_id` | string | Yes | Change request ID returned by a change-request read or search action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### This endpoint will update the state of a change request

**Slug:** `UNLEASH_UPDATE_CHANGE_REQUEST_STATE`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### This endpoint will update the custom title of a change request

**Slug:** `UNLEASH_UPDATE_CHANGE_REQUEST_TITLE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Change request ID returned by a change-request read or search action. |
| `title` | string | Yes | Replacement custom title. Pass an empty string to clear it and show Unleash's default title. |
| `project_id` | string | Yes | Project ID containing the change request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Context Field

**Slug:** `UNLEASH_UPDATE_CONTEXT_FIELD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("root" | "project") | Yes | Use root context fields or the beta context fields for one project. |
| `project` | string | No | Replacement project association for the context field. |
| `project_id` | string | No | Project ID. Required only when scope is project. |
| `sort_order` | integer | No | Replacement order used when listing context fields. |
| `stickiness` | boolean | No | Whether this field can be used for custom stickiness calculations. |
| `description` | string | No | Replacement context-field description. |
| `legal_values` | array | No | Replacement allowed values for the context field. |
| `context_field` | string | Yes | Exact name of the context field to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Updates an environment by name

**Slug:** `UNLEASH_UPDATE_ENVIRONMENT`

Given 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `type` | string | No | Updates the type of environment (i.e. development or production). |
| `sort_order` | integer | No | Changes the sort order of this environment. |
| `required_approvals` | integer | No | Experimental field. The number of approvals required before a change request can be applied in this environment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update environment sort orders

**Slug:** `UNLEASH_UPDATE_ENVIRONMENT_SORT_ORDERS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_orders` | object | Yes | Map of environment names to their desired integer sort orders. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Feature

**Slug:** `UNLEASH_UPDATE_FEATURE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("experiment" | "kill-switch" | "release" | "operational" | "permission" | "sunset") | No | Replacement feature type. |
| `stale` | boolean | No | Whether the feature flag is stale. |
| `archived` | boolean | No | Whether to archive the feature flag. |
| `project_id` | string | Yes | Project ID containing the feature flag. |
| `description` | string | No | Replacement feature description. |
| `feature_name` | string | Yes | Exact feature flag name. |
| `impression_data` | boolean | No | Whether to collect impression data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a feature link

**Slug:** `UNLEASH_UPDATE_FEATURE_LINK`

Update an existing feature link.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL the feature is linked to |
| `title` | string | No | The description of the link |
| `link_id` | string | Yes | Link Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_name` | string | Yes | Feature Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Feature Strategy

**Slug:** `UNLEASH_UPDATE_FEATURE_STRATEGY`

Replace supplied configuration fields on one feature strategy instance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement strategy type name. |
| `title` | string | No | Human-readable title for this strategy instance. |
| `disabled` | boolean | No | Whether this strategy instance is disabled. |
| `segments` | array | No | Numeric segment IDs attached to this strategy. |
| `variants` | array | No | Experimental strategy-level variants. |
| `parameters` | object | No | Provider-defined strategy parameters; values must be strings. |
| `project_id` | string | Yes | Project ID containing the feature flag. |
| `sort_order` | number | No | Evaluation order for the strategy. |
| `constraints` | array | No | Constraints that must match for the strategy. |
| `environment` | string | Yes | Environment name, such as development or production. |
| `strategy_id` | string | Yes | Strategy instance ID returned by Get Feature Environment. |
| `feature_name` | string | Yes | Exact feature flag name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update strategy segments

**Slug:** `UNLEASH_UPDATE_FEATURE_STRATEGY_SEGMENTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | The ID of the project that the strategy belongs to. |
| `segment_ids` | array | Yes | The new list of segments (IDs) to use for this strategy. Any segments not in this list will be removed from the strategy. |
| `strategy_id` | string | Yes | The ID of the strategy to update segments for. |
| `environment_id` | string | Yes | The ID of the strategy environment. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update feature tags

**Slug:** `UNLEASH_UPDATE_FEATURE_TAGS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update feature type lifetime

**Slug:** `UNLEASH_UPDATE_FEATURE_TYPE_LIFETIME`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lifetime_days` | string | Yes | 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. |
| `feature_type_id` | string | Yes | Feature flag type ID returned by List All Feature Types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a group

**Slug:** `UNLEASH_UPDATE_GROUP`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the group |
| `users` | array | No | A list of users belonging to this group |
| `group_id` | string | Yes | Group Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `root_role` | number | No | 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. |
| `description` | string | No | A custom description of the group |
| `mappings_sso` | array | No | A list of SSO groups that should map to this Unleash group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set a new Unleash license

**Slug:** `UNLEASH_UPDATE_LICENSE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `token` | string | Yes | The actual license token. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project

**Slug:** `UNLEASH_UPDATE_PROJECT`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Updates change request configuration for an environment in the project

**Slug:** `UNLEASH_UPDATE_PROJECT_CHANGE_REQUEST_CONFIG`

This endpoint will change the change request configuration for a given environment, set it to either on/off and optionally configure the number of approvals needed. The minimum number of approvals is 1 and the maximum number is 10. If you provide a number higher than 10 or lower than 1, Unleash will clamp it to the allowed range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `environment` | string | Yes | Environment sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `required_approvals` | integer | No | The number of approvals required before a change request can be applied in this environment. |
| `change_requests_enabled` | boolean | Yes | `true` if change requests should be enabled, otherwise `false`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project enterprise settings

**Slug:** `UNLEASH_UPDATE_PROJECT_ENTERPRISE_SETTINGS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("open" | "protected" | "private") | No | A mode of the project affecting what actions are possible in this project |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `feature_naming` | object | No | Create a feature naming pattern |
| `link_templates` | array | No | A list of link templates that can be automatically added to new feature flags. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a milestone strategy

**Slug:** `UNLEASH_UPDATE_PROJECT_MILESTONE_STRATEGY`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a release template

**Slug:** `UNLEASH_UPDATE_RELEASE_TEMPLATE`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a role

**Slug:** `UNLEASH_UPDATE_ROLE`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Segment

**Slug:** `UNLEASH_UPDATE_SEGMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Segment name. |
| `project` | string | No | Project ID that owns the segment, or null for a global segment. |
| `segment_id` | integer | Yes | Numeric segment ID returned by List Segments. |
| `constraints` | array | Yes | Complete list of constraints that define the segment. |
| `description` | string | No | What this segment represents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a service account

**Slug:** `UNLEASH_UPDATE_SERVICE_ACCOUNT`

Updates an existing service account identified by its id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `name` | string | No | The name of the service account |
| `root_role` | integer | No | The id of the root role for the service account |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] Update a signal endpoint

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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### [BETA] Update a signal endpoint token

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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `name` | string | Yes | The signal endpoint token name. |
| `signal_endpoint_id` | string | Yes | Signal Endpoint Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a strategy type

**Slug:** `UNLEASH_UPDATE_STRATEGY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `parameters` | array | Yes | 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. |
| `description` | string | No | A description of the strategy type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a tag type

**Slug:** `UNLEASH_UPDATE_TAG_TYPE`

Update the configuration for the specified tag type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `icon` | string | No | The icon of the tag type. |
| `name` | string | Yes | Name sent in the request path. See the cited Admin OpenAPI schema for accepted values. |
| `color` | string | No | The hexadecimal color code for the tag type. |
| `description` | string | No | The description of the tag type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a user

**Slug:** `UNLEASH_UPDATE_USER`

Only the explicitly specified fields get updated.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | a user id |
| `name` | string | No | The user's name (not the user's username). |
| `email` | string | No | The user's email address. Must be provided if username is not provided. |
| `root_role` | string | No | The role to assign to the user. Can be either the role's ID or its unique name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Context Field Legal Value

**Slug:** `UNLEASH_UPSERT_CONTEXT_FIELD_LEGAL_VALUE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("root" | "project") | Yes | Use root context fields or the beta context fields for one project. |
| `value` | string | Yes | Legal value to add or update. |
| `project_id` | string | No | Project ID. Required only when scope is project. |
| `description` | string | No | Optional explanation of the legal value. |
| `context_field` | string | Yes | Exact name of the context field whose legal value is set. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create or update safeguard

**Slug:** `UNLEASH_UPSERT_SAFEGUARD`

Create or update a metric-threshold safeguard for a feature environment or for one release plan. Set target to release_plan and provide plan_id for a release-plan safeguard; omit plan_id for feature_environment. Returns the saved safeguard and its ID for DELETE_SAFEGUARD.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target` | string ("feature_environment" | "release_plan") | Yes | Safeguard target: the feature environment itself or one release plan. |
| `plan_id` | string | No | Release plan ID. Required only when target is release_plan. |
| `project_id` | string | Yes | Project ID containing the feature flag. |
| `environment` | string | Yes | Environment name containing the safeguard. |
| `feature_name` | string | Yes | Exact feature flag name. |
| `impact_metric` | object | Yes | Metric configuration evaluated by the safeguard. |
| `trigger_condition` | object | Yes | Threshold condition that triggers the safeguard. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validates archive features

**Slug:** `UNLEASH_VALIDATE_ARCHIVE_FEATURES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `features` | array | Yes | List of feature flag names |
| `project_id` | string | Yes | Project Id sent in the request path. See the cited Admin OpenAPI schema for accepted values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate constraint

**Slug:** `UNLEASH_VALIDATE_CONSTRAINT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | No | The context value that should be used for constraint evaluation. Use this property instead of `values` for properties that only accept single values. |
| `values` | array | No | The context values that should be used for constraint evaluation. Use this property instead of `value` for properties that accept multiple values. |
| `inverted` | boolean | No | Whether the result should be negated or not. If `true`, will turn a `true` result into a `false` result and vice versa. |
| `operator` | 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") | Yes | The operator to use when evaluating this constraint. For more information about the various operators, refer to [the strategy constraint operator documentation](https://docs.getunleash.io/concepts/activation-strategies#constraint-operators). |
| `context_name` | string | Yes | The name of the context field that this constraint should apply to. |
| `case_insensitive` | boolean | No | Whether the operator should be case sensitive or not. Defaults to `false` (being case sensitive). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate Context Field Name

**Slug:** `UNLEASH_VALIDATE_CONTEXT_FIELD_NAME`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Proposed context-field name to validate. |
| `scope` | string ("root" | "project") | Yes | Use root context fields or the beta context fields for one project. |
| `project_id` | string | No | Project ID. Required only when scope is project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validates if an environment name exists

**Slug:** `UNLEASH_VALIDATE_ENVIRONMENT_NAME`

Checks whether an environment name is already in use.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the represented object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate an external impact-metrics source URL

**Slug:** `UNLEASH_VALIDATE_EXTERNAL_IMPACT_METRICS_SOURCE`

Tests an external impact-metrics source URL on the fly without persisting it. Returns the list of metric names found at the URL on success, or an `error` string explaining what went wrong. Always responds with 200; failures are reported in the body.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate a feature flag name

**Slug:** `UNLEASH_VALIDATE_FEATURE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The feature name to validate. |
| `project_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate feature import data

**Slug:** `UNLEASH_VALIDATE_IMPORT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | 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.) |
| `project` | string | Yes | The exported [project](https://docs.getunleash.io/concepts/projects) |
| `environment` | string | Yes | The exported [environment](https://docs.getunleash.io/concepts/environments) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate project ID

**Slug:** `UNLEASH_VALIDATE_PROJECT`

Validate a project ID against Unleash's rules

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The project ID to validate |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate a role

**Slug:** `UNLEASH_VALIDATE_ROLE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Role definition to validate. At minimum, provide the custom role name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validates if a segment name exists

**Slug:** `UNLEASH_VALIDATE_SEGMENT`

Checks whether a segment name is already in use.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the represented object. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate a tag type

**Slug:** `UNLEASH_VALIDATE_TAG_TYPE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `icon` | string | No | The icon of the tag type. |
| `name` | string | Yes | The name of the tag type. |
| `color` | string | No | The hexadecimal color code for the tag type. |
| `description` | string | No | The description of the tag type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Validate password for a user

**Slug:** `UNLEASH_VALIDATE_USER_PASSWORD`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `password` | string | Yes | The password whose strength to validate. Treat this value as a secret and never log it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |