{ "opencollection": "1.0.0", "info": { "name": "Unleash Admin API", "version": "7.4.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "Get a List of All Projects.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects", "params": [ { "name": "archived", "value": "", "type": "query" } ] }, "docs": "This endpoint returns an list of all the projects in the Unleash instance." }, { "info": { "name": "Create Project", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nCreate a new [Unleash project](https://docs.getunleash.io/concepts/projects)." }, { "info": { "name": "Validate Project ID", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/validate", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nValidate a project ID against Unleash's rules" }, { "info": { "name": "Update Project", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nUpdate a project with new configuration. Any fields not provided are ignored." }, { "info": { "name": "Delete Project", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nPermanently 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." }, { "info": { "name": "Update Project Enterprise Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/settings", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nUpdate project enterprise settings with new values. Any fields not provided are ignored." }, { "info": { "name": "Get Users and Groups in Project", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/access", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nGet all groups, users and their roles, and available roles for the given project." }, { "info": { "name": "Configure Project Access", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/access", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nConfigure project access for groups and single users. The provided users and groups will be given the roles specified in the payload." }, { "info": { "name": "Set Users and Groups to Roles in the Current Project", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/access", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nSets all groups, users and their roles for the given project, overriding any existing configuration." }, { "info": { "name": "Get Project-role Mappings", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/roles/:roleId/access", "params": [ { "name": "roleId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nFor 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." }, { "info": { "name": "Sets Roles for User", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/users/:userId/roles", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nSets the roles a user has in the project." }, { "info": { "name": "Remove Project Access for a User", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/users/:userId/roles", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nRemoves project access for a user by removing all of its roles for the project." }, { "info": { "name": "Sets Roles for Group", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/groups/:groupId/roles", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nSets the roles a group has in the project." }, { "info": { "name": "Remove Project Access for a Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/groups/:groupId/roles", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nRemoves project access for a group by removing all of its roles for the project." }, { "info": { "name": "Get an Overview of a Project.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/overview", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Get an Overview Project Dora Metrics.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/dora", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "This endpoint returns an overview of the specified dora metrics" }, { "info": { "name": "Get a List of All Applications for a Project.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/applications", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "query", "value": "", "type": "query", "description": "The search query for the application name, sdk, environment" }, { "name": "offset", "value": "", "type": "query", "description": "The number of applications to skip when returning a page. By default it is set to 0." }, { "name": "limit", "value": "", "type": "query", "description": "The number of applications to return in a page. By default it is set to 50." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort the results by. By default it is set to \"appName\"." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order for the sortBy. By default it is det to \"asc\"." } ] }, "docs": "This endpoint returns an list of all the applications for a project." }, { "info": { "name": "Get a List of All Flag Creators for a Project.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/flag-creators", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "This endpoint returns every user who created a flag in the project." }, { "info": { "name": "Get Outdated Project Sdks", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/sdks/outdated", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "Returns a list of the outdated SDKS with the applications using them." }, { "info": { "name": "Add an Environment to a Project.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/environments", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint adds the provided environment to the specified project, with optional support for enabling and disabling change requests for the environment and project." }, { "info": { "name": "Remove an Environment From a Project.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/environments/:environment", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ] }, "docs": "This endpoint removes the specified environment from the project." }, { "info": { "name": "Set Environment-default Strategy", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/environments/:environment/default-strategy", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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. " }, { "info": { "name": "Get a Health Report for a Project.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/health-report", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "This endpoint returns a health report for the specified project. This data is used for [the technical debt insights](https://docs.getunleash.io/concepts/technical-debt)" }, { "info": { "name": "Get API Tokens for Project.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/api-tokens", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "Returns the project-specific [API tokens](https://docs.getunleash.io/concepts/api-tokens) that have been created for this project." }, { "info": { "name": "Create a Project API Token.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/api-tokens", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Endpoint that allows creation of [project API tokens](https://docs.getunleash.io/concepts/api-tokens-and-client-keys#api-token-visibility) for the specified project." }, { "info": { "name": "Delete a Project API Token.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/api-tokens/:token", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "token", "value": "", "type": "path" } ] }, "docs": "This operation deletes the API token specified in the request URL. If the token doesn't exist, returns an OK response (status code 200)." }, { "info": { "name": "Get an Overview of a Project Insights.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/insights", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "This endpoint returns insights into the specified projects stats, health, lead time for changes, feature types used, members and change requests." } ] }, { "info": { "name": "Unstable", "type": "folder" }, "items": [ { "info": { "name": "Archive Project", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/archive/:projectId", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nArchive the provided project. All feature flags in the project must be archived before you can archive the project." }, { "info": { "name": "Revive Project", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/revive/:projectId", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nRevive the specified project from the archive." }, { "info": { "name": "Get Aggregated Metered Connections for a Given Time Period.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/metrics/connection", "params": [ { "name": "grouping", "value": "", "type": "query", "description": "Whether to aggregate the data by month or by day" }, { "name": "from", "value": "", "type": "query", "description": "The starting date of the traffic data usage search in IS:yyyy-MM-dd format" }, { "name": "to", "value": "", "type": "query", "description": "The starting date of the traffic data usage search in IS:yyyy-MM-dd format" } ] }, "docs": "**Enterprise feature**\n\nGets metered connections count for the selected period, either aggregated by day or by month." }, { "info": { "name": "Get Aggregated Metered Requests for a Given Time Period.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/metrics/request", "params": [ { "name": "grouping", "value": "", "type": "query", "description": "Whether to aggregate the data by month or by day" }, { "name": "from", "value": "", "type": "query", "description": "The starting date of the traffic data usage search in IS:yyyy-MM-dd format" }, { "name": "to", "value": "", "type": "query", "description": "The starting date of the traffic data usage search in IS:yyyy-MM-dd format" } ] }, "docs": "**Enterprise feature**\n\nGets metered requests count for the selected period, either aggregated by day or by month." }, { "info": { "name": "Get Instance Information", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/insights", "params": [ { "name": "from", "value": "", "type": "query", "description": "The beginning of the date range in yyyy-MM-dd format" }, { "name": "to", "value": "", "type": "query", "description": "The end of the date range in yyyy-MM-dd format" } ] }, "docs": "**Enterprise feature**\n\nGets high level information about the usage of this Unleash instance, including user, project, and flag information." }, { "info": { "name": "Subscribe to Email Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/email-subscription/:subscription", "params": [ { "name": "subscription", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nSubscribe to email subscription e.g. monthly productivity report. By default everyone is subscribed. This API is mostly used by hosted Unleash." }, { "info": { "name": "Unsubscribe From Email Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/email-subscription/:subscription", "params": [ { "name": "subscription", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nUnsubscribe from email subscription e.g. monthly productivity report. This API is mostly used by hosted Unleash." }, { "info": { "name": "Retrieves All Licensed Users Data.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/licensed-users" }, "docs": "**Enterprise feature**\n\nFetches an array of licensed users with date and count." }, { "info": { "name": "Heartbeat for Enterprise Edge Instances.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/client/edge-licensing/heartbeat" }, "docs": "**Enterprise feature**\n\nReports that an Enterprise Edge instance is alive and in use. This is related to billing and usage tracking." }, { "info": { "name": "Get the Number of Change Requests You Can Do Something With", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/actionable", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nReturns the number of change requests in this project that your user can move into the next stage by approving or applying them." }, { "info": { "name": "Get All Feedback Events. Limited to 2000 Items.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/feedback" }, "docs": "**Enterprise feature**\n\nGet all feedback events." }, { "info": { "name": "Submit User Feedback", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/feedback", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nAllows users to submit feedback." }, { "info": { "name": "Get a Cdn Tokens.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/cdn/tokens" }, "docs": "**Enterprise feature**\n\nRetrieves all CDN tokens for the specified Edge instance." }, { "info": { "name": "Create a Cdn Token.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/cdn/tokens", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nCreates a new CDN token for the specified Edge instance." }, { "info": { "name": "Get SCIM Settings.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/scim-settings" }, "docs": "**Enterprise feature**\n\nReturns the current settings for SCIM provisioning." }, { "info": { "name": "Set SCIM Settings.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/scim-settings", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nSets new settings for SCIM provisioning." }, { "info": { "name": "Generates a New SCIM API Token.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/scim-settings/generate-new-token" }, "docs": "**Enterprise feature**\n\nGenerates a new SCIM API token. Previously generated tokens will be invalidated." }, { "info": { "name": "Connect to the Streaming Api.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/client/streaming" }, "docs": "**Enterprise feature**\n\nConnects to the client features SSE streaming API." }, { "info": { "name": "Get Partial Updates (sdk)", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/client/delta" }, "docs": "**Enterprise feature**\n\nInitially returns the full set of feature flags available to the provided API key. When called again with the returned etag, only returns the flags that have changed" }, { "info": { "name": "Disconnect All Clients.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/streaming/disconnect-all" }, "docs": "**Enterprise feature**\n\nDisconnects all streaming clients." }, { "info": { "name": "Get Plausible Analytics Data", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/impact-metrics/plausible" }, "docs": "**Enterprise feature**\n\nFetches analytics data from Plausible API for favorite events over the last 7 days." }, { "info": { "name": "Get Impact Metrics Configurations for a Single Feature", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/impact-metrics/config", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nGets all impact metrics configurations associated with a specific feature flag." }, { "info": { "name": "Save Flag Level Impact Metrics Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/impact-metrics/config", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nSaves a configuration for an impact metric chart associated with a feature flag." }, { "info": { "name": "Get Impact Metrics Configuration for the Instance", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/impact-metrics/config" }, "docs": "**Enterprise feature**\n\nGets all impact metrics configurations now associated with any feature flag." }, { "info": { "name": "Save Instance Level Impact Metrics Configuration", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/impact-metrics/config", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nSaves a configuration for an instance level impact metric chart without a feature flag" }, { "info": { "name": "Delete Flag Level Impact Metric Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/impact-metrics/config/:id", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nDeletes an impact metric configuration by its ID." }, { "info": { "name": "Delete Instance Level Impact Metric Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/impact-metrics/config/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nDeletes an impact metric configuration by its ID." }, { "info": { "name": "Create or Update a Milestone Progression", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/progressions/:id", "params": [ { "name": "project", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nThis is a beta endpoint and it may change or be removed in the future.\n\nCreates 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." }, { "info": { "name": "Delete a Milestone Progression", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/progressions/:id", "params": [ { "name": "project", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis is a beta endpoint and it may change or be removed in the future.\n\nDeletes an existing milestone progression by source milestone ID." }, { "info": { "name": "Resume Paused Milestone Progressions", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/progressions/:planId/resume", "params": [ { "name": "project", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" }, { "name": "planId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis is a beta endpoint and it may change or be removed in the future.\n\nResumes all paused milestone progressions for a release plan" }, { "info": { "name": "Change a Safeguard", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/release-plans/:planId/safeguards", "params": [ { "name": "project", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" }, { "name": "planId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nThis is a beta endpoint and it may change or be removed in the future.\n\nCreates or updates a safeguard for a specific feature, environment, and release plan." }, { "info": { "name": "Delete a Safeguard", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/release-plans/:planId/safeguards/:safeguardId", "params": [ { "name": "project", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" }, { "name": "planId", "value": "", "type": "path" }, { "name": "safeguardId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis is a beta endpoint and it may change or be removed in the future.\n\nDeletes a safeguard by its ID for a specific feature, environment, and release plan." }, { "info": { "name": "Returns the List of Permissions for the User", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/user-admin/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path", "description": "a user id" }, { "name": "project", "value": "", "type": "query" }, { "name": "environment", "value": "", "type": "query" } ] }, "docs": "Gets a list of permissions for a user, additional project and environment can be specified." }, { "info": { "name": "Get Project Status", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/status", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "This endpoint returns information on the status the project, including activities, health, resources, and aggregated flag lifecycle data." }, { "info": { "name": "Get Feature Lifecycle", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/lifecycle", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ] }, "docs": "Information about the lifecycle stages of the feature." }, { "info": { "name": "Set Feature Completed", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/lifecycle/complete", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This will set the feature as completed." }, { "info": { "name": "Set Feature Uncompleted", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/lifecycle/uncomplete", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ] }, "docs": "This will set the feature as uncompleted." }, { "info": { "name": "Create a Feature Link", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/link", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new link for a feature." }, { "info": { "name": "Update a Feature Link", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/link/:linkId", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "linkId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing feature link." }, { "info": { "name": "Delete a Feature Link", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/link/:linkId", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "linkId", "value": "", "type": "path" } ] }, "docs": "Delete a feature link by id." }, { "info": { "name": "Get All Features Lifecycle Stage Count", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/lifecycle/count" }, "docs": "Information about the number of features in each lifecycle stage." }, { "info": { "name": "Get Personal Dashboard", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/personal-dashboard" }, "docs": "Return all projects and flags that are relevant to the user." }, { "info": { "name": "Get Personal Project Details", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/personal-dashboard/:projectId", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "Return personal dashboard project events, owners, user roles and onboarding status" } ] }, { "info": { "name": "Features", "type": "folder" }, "items": [ { "info": { "name": "Move Feature to Project", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/changeProject", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nMoves 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." }, { "info": { "name": "Validate a Feature Flag Name.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/features/validate", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get All Tags for a Feature.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/features/:featureName/tags", "params": [ { "name": "featureName", "value": "", "type": "path" } ] }, "docs": "Retrieves all the tags for a feature name. If the feature does not exist it returns an empty list." }, { "info": { "name": "Adds a Tag to a Feature.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/features/:featureName/tags", "params": [ { "name": "featureName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a tag to a feature if the feature and tag type exist in the system. The operation is idempotent, so adding an existing tag will result in a successful response." }, { "info": { "name": "Updates Multiple Tags for a Feature.", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/features/:featureName/tags", "params": [ { "name": "featureName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Receives a list of tags to add and a list of tags to remove that are mandatory but can be empty. All tags under addedTags are first added to the feature and then all tags under removedTags are removed from the feature." }, { "info": { "name": "Removes a Tag From a Feature.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/features/:featureName/tags/:type/:value", "params": [ { "name": "featureName", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "path" }, { "name": "value", "value": "", "type": "path" } ] }, "docs": "Removes a tag from a feature. If the feature exists but the tag does not, it returns a successful response." }, { "info": { "name": "Get a Feature Environment", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ] }, "docs": "Information about the enablement status and strategies for a feature flag in specified environment." }, { "info": { "name": "Disable a Feature Flag", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment/off", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ] }, "docs": "Disable a feature flag in the specified environment." }, { "info": { "name": "Enable a Feature Flag", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment/on", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ] }, "docs": "Enable a feature flag in the specified environment." }, { "info": { "name": "Bulk Enable a List of Features", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/bulk_features/environments/:environment/on", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint enables multiple feature flags." }, { "info": { "name": "Bulk Disable a List of Features", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/bulk_features/environments/:environment/off", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint disables multiple feature flags." }, { "info": { "name": "Get Feature Flag Strategies", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment/strategies", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ] }, "docs": "Get strategies defined for a feature flag in the specified environment." }, { "info": { "name": "Add a Strategy to a Feature Flag", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment/strategies", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a strategy to a feature flag in the specified environment." }, { "info": { "name": "Get a Strategy Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment/strategies/:strategyId", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" }, { "name": "strategyId", "value": "", "type": "path" } ] }, "docs": "Get a strategy configuration for an environment in a feature flag." }, { "info": { "name": "Update a Strategy", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment/strategies/:strategyId", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" }, { "name": "strategyId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace strategy configuration for a feature flag in the specified environment." }, { "info": { "name": "Change Specific Properties of a Strategy", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment/strategies/:strategyId", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" }, { "name": "strategyId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change specific properties of a strategy configuration in a feature flag." }, { "info": { "name": "Delete a Strategy From a Feature Flag", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment/strategies/:strategyId", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" }, { "name": "strategyId", "value": "", "type": "path" } ] }, "docs": "Delete a strategy configuration from a feature flag in the specified environment." }, { "info": { "name": "Set Strategy Sort Order", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment/strategies/set-sort-order", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the sort order of the provided list of strategies." }, { "info": { "name": "Get All Features in a Project", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "A list of all features for the specified project." }, { "info": { "name": "Add a New Feature Flag", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new feature flag in a specified project." }, { "info": { "name": "Clone a Feature Flag", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/clone", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a copy of the specified feature flag. The copy can be created in any project." }, { "info": { "name": "Get a Feature", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ] }, "docs": "This endpoint returns the information about the requested feature if the feature belongs to the specified project." }, { "info": { "name": "Update a Feature Flag", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified feature if the feature belongs to the specified project. Only the provided properties are updated; any feature properties left out of the request body are left untouched." }, { "info": { "name": "Modify a Feature Flag", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change specific properties of a feature flag." }, { "info": { "name": "Archive a Feature Flag", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ] }, "docs": "This endpoint archives the specified feature if the feature belongs to the specified project." }, { "info": { "name": "Mark Features as Stale / Not Stale", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/stale", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get Variants for a Feature in an Environment", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment/variants", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ] }, "docs": "Returns the variants for a feature in a specific environment. If the feature has no variants it will return an empty array of variants" }, { "info": { "name": "Create (overwrite) Variants for a Feature in an Environment", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment/variants", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This overwrites the current variants for the feature flag in the :featureName parameter for the :environment parameter.\n\nThe backend will validate the input for the following invariants:\n\n* If there are variants, there needs to be at least one variant with `weightType: variable`\n\n* The sum of the weights of variants with `weightType: fix` must be strictly less than 1000 (< 1000)\n\nThe backend will also distribute remaining weight up to 1000 after adding the variants with `weightType: fix` togethe" }, { "info": { "name": "Patch a Feature's Variants in an Environment", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/environments/:environment/variants", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Create (overwrite) Variants for a Feature Flag in Multiple Environments", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/variants-batch", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This overwrites the current variants for the feature flag in the :featureName parameter for the :environment parameter." }, { "info": { "name": "Validates Archive Features", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/archive/validate", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint return info about the archive features impact." }, { "info": { "name": "Archives a List of Features", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/archive", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Validate Constraint", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/constraints/validate", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Add Feature to Favorites", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/favorites", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ] }, "docs": "This endpoint marks the feature in the url as favorite" }, { "info": { "name": "Remove Feature From Favorites", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:featureName/favorites", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ] }, "docs": "This endpoint removes the feature in the url from favorites" }, { "info": { "name": "Add Project to Favorites", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/favorites", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "This endpoint marks the project in the url as favorite" }, { "info": { "name": "Remove Project From Favorites", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/favorites", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "This endpoint removes the project in the url from favorites" } ] }, { "info": { "name": "Auth", "type": "folder" }, "items": [ { "info": { "name": "Gets Available Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/permissions" }, "docs": "**Enterprise feature**\n\nReturns a list of available permissions" }, { "info": { "name": "Log in", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/auth/simple/login", "body": { "type": "json", "data": "{}" } }, "docs": "Logs in the user and creates an active session" }, { "info": { "name": "Get SAML Auth Settings", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/auth/saml/settings" }, "docs": "**Enterprise feature**\n\nReturns the current settings for SAML authentication" }, { "info": { "name": "Update SAML Auth Settings", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/auth/saml/settings", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nUpdates the settings for SAML Authentication" }, { "info": { "name": "Get OIDC Auth Settings", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/auth/oidc/settings" }, "docs": "**Enterprise feature**\n\nReturns the current settings for OIDC Authentication" }, { "info": { "name": "Set OIDC Settings", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/auth/oidc/settings", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nConfigure OpenID Connect as a login provider for Unleash." }, { "info": { "name": "Get Simple Auth Settings", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/auth/simple/settings" }, "docs": "**Enterprise feature**\n\nIs simple authentication (username/password) enabled for this server" }, { "info": { "name": "Update Simple Auth Settings", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/auth/simple/settings", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nEnable or disable simple authentication (username/password)" }, { "info": { "name": "Returns the List of Permissions for the Service Account.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/service-account/:id/permissions", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "project", "value": "", "type": "query" }, { "name": "environment", "value": "", "type": "query" } ] }, "docs": "**Enterprise feature**\n\nGets a list of permissions for a service account. Project and environment can be specified." }, { "info": { "name": "Gets Access Overview", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/access/overview" }, "docs": "**Enterprise feature**\n\nGets an overview of what access all users have to all projects and groups" }, { "info": { "name": "Validates a Token", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/auth/reset/validate" }, "docs": "If the token is valid returns the user that owns the token" }, { "info": { "name": "Changes a User Password", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/auth/reset/password", "body": { "type": "json", "data": "{}" } }, "docs": "Allows users with a valid reset token to reset their password without remembering their old password" }, { "info": { "name": "Validates Password", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/auth/reset/validate-password", "body": { "type": "json", "data": "{}" } }, "docs": "Verifies that the password adheres to the [Unleash password guidelines](https://docs.getunleash.io/using-unleash/deploy/configuring-unleash#securing-unleash)" }, { "info": { "name": "Reset Password", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/auth/reset/password-email", "body": { "type": "json", "data": "{}" } }, "docs": "Requests a password reset email for the user. This email can be used to reset the password for a user that has forgotten their password" } ] }, { "info": { "name": "Metrics", "type": "folder" }, "items": [ { "info": { "name": "Gets Usage Data", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/metrics/rps" }, "docs": "**Enterprise feature**\n\nGets usage data per app/endpoint from a prometheus compatible metrics endpoint" }, { "info": { "name": "Get Aggregated Traffic Data for a Given Time Period.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/metrics/traffic", "params": [ { "name": "grouping", "value": "", "type": "query", "description": "Whether to aggregate the data by month or by day" }, { "name": "from", "value": "", "type": "query", "description": "The starting date of the traffic data usage search in IS:yyyy-MM-dd format" }, { "name": "to", "value": "", "type": "query", "description": "The starting date of the traffic data usage search in IS:yyyy-MM-dd format" } ] }, "docs": "**Enterprise feature**\n\nGets traffic usage data for the selected period, either aggregated by day or by month." }, { "info": { "name": "Get Application Data", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/metrics/applications/:appName", "params": [ { "name": "appName", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Create an Application to Connect Reported Metrics", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/metrics/applications/:appName", "params": [ { "name": "appName", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Is used to report usage as well which sdk the application uses" }, { "info": { "name": "Delete an Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/metrics/applications/:appName", "params": [ { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Delete the application specified in the request URL. Returns 200 OK if the application was successfully deleted or if it didn't exist" }, { "info": { "name": "Get All Applications", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/metrics/applications", "params": [ { "name": "query", "value": "", "type": "query", "description": "The search query for the application name" }, { "name": "offset", "value": "", "type": "query", "description": "The number of applications to skip when returning a page. By default it is set to 0." }, { "name": "limit", "value": "", "type": "query", "description": "The number of applications to return in a page. By default it is set to 1000." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort the results by. By default it is set to \"appName\"." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order for the sortBy. By default it is det to \"asc\"." } ] }, "docs": "Returns all applications registered with Unleash. Applications can be created via metrics reporting or manual creation" }, { "info": { "name": "Get Application Overview", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/metrics/applications/:appName/overview", "params": [ { "name": "appName", "value": "", "type": "path" } ] }, "docs": "Returns an overview of the specified application (`appName`)." }, { "info": { "name": "Get Application Environment Instances (last 24h)", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/metrics/instances/:appName/environment/:environment", "params": [ { "name": "appName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ] }, "docs": "Returns an overview of the instances for the given `appName` and `environment` that have received traffic in the last 24 hours." }, { "info": { "name": "Get Outdated Sdks", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/metrics/sdks/outdated" }, "docs": "Returns a list of the outdated SDKS with the applications using them." }, { "info": { "name": "Get Feature Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/client-metrics/features/:name/raw", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get usage metrics for a specific feature for the last 48 hours, grouped by hour" }, { "info": { "name": "Last Hour of Usage and a List of Applications That Have Reported Seeing This Feature Flag", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/client-metrics/features/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Separate counts for yes (enabled), no (disabled), as well as how many times each variant was selected during the last hour" }, { "info": { "name": "Get Stored Custom Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/custom-metrics" }, "docs": "Retrieves the stored custom metrics data." }, { "info": { "name": "Get Metrics in Prometheus Format", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/custom-metrics/prometheus" }, "docs": "Exposes all custom metrics in Prometheus text format for scraping." } ] }, { "info": { "name": "Notifications", "type": "folder" }, "items": [ { "info": { "name": "Retrieves a List of Notifications", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/notifications" }, "docs": "**Enterprise feature**\n\nA user may get relevant notifications from the projects they are a member of" }, { "info": { "name": "Mark Notifications as Read", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/notifications/read", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nAllow to select which notifications were read and saving a read date" } ] }, { "info": { "name": "Admin UI", "type": "folder" }, "items": [ { "info": { "name": "Get Lifecycle Trends", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/insights/lifecycle", "params": [ { "name": "projects", "value": "", "type": "query", "description": "Comma-separated list of project IDs to filter lifecycle trends" } ] }, "docs": "**Enterprise feature**\n\nGets lifecycle trends information showing feature flag progression across development, production, and cleanup stages." }, { "info": { "name": "Send Unleash Feedback", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/feedback", "body": { "type": "json", "data": "{}" } }, "docs": "Sends feedback gathered from the Unleash UI to the Unleash server. Must be called with a token with an identifiable user (either from being sent from the UI or from using a [PAT](https://docs.getunleash.io/concepts/api-tokens-and-client-keys#personal-access-tokens))." }, { "info": { "name": "Get UI Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/ui-config" }, "docs": "Retrieves the full configuration used to set up the Unleash Admin UI." }, { "info": { "name": "Sets Allowed Cors Origins", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/ui-config/cors", "body": { "type": "json", "data": "{}" } }, "docs": "Sets Cross-Origin Resource Sharing headers for Frontend SDK API." }, { "info": { "name": "Update Unleash Feedback", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/feedback/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the feedback with the provided ID. Only provided fields are updated. Fields left out are left untouched. Must be called with a token with an identifiable user (either from being sent from the UI or from using a [PAT](https://docs.getunleash.io/concepts/api-tokens-and-client-keys#personal-access-tokens))." }, { "info": { "name": "Update Splash Settings", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/splash/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This operation updates splash settings for a user, indicating that they have seen a particualar splash screen." }, { "info": { "name": "Accepts Errors From the UI Client", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/record-ui-error", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint accepts error reports from the UI client, so that we can add observability on UI errors." } ] }, { "info": { "name": "Unleash Edge", "type": "folder" }, "items": [ { "info": { "name": "Register Edge Observability Metrics.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/client/metrics/edge", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nRegisters Edge observability metrics from downstream Edge instances to aggregate a comprehensive status view of connected Edges." }, { "info": { "name": "Send Metrics in Bulk", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/client/metrics/bulk", "body": { "type": "json", "data": "{}" } }, "docs": "This operation accepts batched metrics from any client. Metrics will be inserted into Unleash's metrics storage" }, { "info": { "name": "Check Which Tokens Are Valid", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/edge/validate", "body": { "type": "json", "data": "{}" } }, "docs": "This operation accepts a list of tokens to validate. Unleash will validate each token you provide. For each valid token you provide, Unleash will return the token along with its type and which projects it has access to." } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Get a List of Groups", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/groups" }, "docs": "**Enterprise feature**\n\nGet a list of user groups for Role-Based Access Control" }, { "info": { "name": "Create a New Group", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/groups", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nCreate a new user group for Role-Based Access Control" }, { "info": { "name": "Get a Single Group", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nGet a single user group by group id" }, { "info": { "name": "Update a Group", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nUpdate existing user group by group id. It overrides previous group details." }, { "info": { "name": "Delete a Single Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nDelete a single user group by group id" }, { "info": { "name": "Delete All SCIM Groups", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/groups/scim-groups" }, "docs": "**Enterprise feature**\n\nDeletes all groups managed by SCIM" }, { "info": { "name": "Get a List of Roles", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/roles" }, "docs": "**Enterprise feature**\n\nGet a list of project, root and custom roles for Role-Based Access Control" }, { "info": { "name": "Create a New Role", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/roles", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nCreate a new custom role for Role-Based Access Control" }, { "info": { "name": "Get a Single Role", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/roles/:roleId", "params": [ { "name": "roleId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nGet a single role by role id" }, { "info": { "name": "Update a Role", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/roles/:roleId", "params": [ { "name": "roleId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nUpdate a custom role by role id" }, { "info": { "name": "Delete a Custom Role", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/roles/:roleId", "params": [ { "name": "roleId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nDelete a custom role by id. You cannot delete built-in roles or roles that are in use." }, { "info": { "name": "Validate a Role", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/roles/validate", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nCheck if the role matches schema and has a unique name" }, { "info": { "name": "Get Your Own User Details", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/user" }, "docs": "Detailed information about the current user, user permissions and user feedback" }, { "info": { "name": "Get Your Own User Profile", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/user/profile" }, "docs": "Detailed information about the current user root role and project membership" }, { "info": { "name": "Change Your Own Password", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/user/change-password", "body": { "type": "json", "data": "{}" } }, "docs": "Requires specifying old password and confirming new password" }, { "info": { "name": "Get Roles for Currently Logged in User", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/user/roles", "params": [ { "name": "projectId", "value": "", "type": "query", "description": "The id of the project you want to check permissions for" } ] }, "docs": "Gets roles assigned to currently logged in user. Both explicitly and transitively through group memberships" }, { "info": { "name": "Gets Inactive Users", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/user-admin/inactive" }, "docs": "Gets all inactive users. An inactive user is a user that has not logged in in the last 180 days" }, { "info": { "name": "Deletes Inactive Users", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/user-admin/inactive/delete", "body": { "type": "json", "data": "{}" } }, "docs": "Deletes all inactive users. An inactive user is a user that has not logged in in the last 180 days" }, { "info": { "name": "Validate Password for a User", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/user-admin/validate-password", "body": { "type": "json", "data": "{}" } }, "docs": "Validate the password strength. Minimum 10 characters, uppercase letter, number, special character." }, { "info": { "name": "Change Password for a User", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/user-admin/:id/change-password", "params": [ { "name": "id", "value": "", "type": "path", "description": "a user id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change password for a user as an admin" }, { "info": { "name": "Reset User Password", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/user-admin/reset-password", "body": { "type": "json", "data": "{}" } }, "docs": "Reset user password as an admin" }, { "info": { "name": "Get All Users and [root Roles](https://docs.getunleash.io/concepts/rbac#predefined-roles)", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/user-admin" }, "docs": "Will return all users and all available root roles for the Unleash instance." }, { "info": { "name": "Create a New User", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/user-admin", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new user with the given root role." }, { "info": { "name": "Search Users", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/user-admin/search", "params": [ { "name": "q", "value": "", "type": "query", "description": "The pattern to search in the username or email" } ] }, "docs": " It will preform a simple search based on name and email matching the given query. Requires minimum 2 characters" }, { "info": { "name": "Get Basic User and Group Information", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/user-admin/access" }, "docs": "Get a subset of user and group information eligible even for non-admin users" }, { "info": { "name": "Get Total Count of Admin Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/user-admin/admin-count" }, "docs": "Get a total count of admins with password, without password and admin service accounts" }, { "info": { "name": "Get User", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/user-admin/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "a user id" } ] }, "docs": "Will return a single user by id" }, { "info": { "name": "Update a User", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/user-admin/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "a user id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Only the explicitly specified fields get updated." }, { "info": { "name": "Delete a User", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/user-admin/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "a user id" } ] }, "docs": "Deletes the user with the given userId" }, { "info": { "name": "Delete All SCIM Users", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/user-admin/scim-users" }, "docs": "Deletes all users managed by SCIM" } ] }, { "info": { "name": "Environments", "type": "folder" }, "items": [ { "info": { "name": "Get All Environments", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/environments" }, "docs": "Retrieves all environments that exist in this Unleash instance." }, { "info": { "name": "Creates a New Environment", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/environments", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nUses the details provided in the payload to create a new environment" }, { "info": { "name": "Validates If an Environment Name Exists", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/environments/validate", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nUses the name provided in the body of the request to validate if the given name exists or not" }, { "info": { "name": "Updates an Environment by Name", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/environments/update/:name", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nGiven an environment by name updates the environment with the given payload. Note that `name`, `enabled` and `protected` cannot be changed by this API" }, { "info": { "name": "Get the Environment With `name`", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/environments/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Retrieves the environment with `name` if it exists in this Unleash instance" }, { "info": { "name": "Deletes an Environment by Name", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/environments/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nGiven an existing environment by name, this endpoint will attempt to delete it" }, { "info": { "name": "Clones an Environment", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/environments/:name/clone", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nGiven an existing environment name and a set of options, this will create a copy of that environment" }, { "info": { "name": "Get the Environments Available to a Project", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/environments/project/:projectId", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "Gets the environments that are available for this project. An environment is available for a project if enabled in the [project configuration](https://docs.getunleash.io/concepts/environments#enable-an-environment)" }, { "info": { "name": "Update Environment Sort Orders", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/environments/sort-order", "body": { "type": "json", "data": "{}" } }, "docs": "Updates sort orders for the named environments. Environments not specified are unaffected." }, { "info": { "name": "Toggle the Environment With `name` on", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/environments/:name/on", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Makes it possible to enable this environment for a project. An environment must first be globally enabled using this endpoint before it can be enabled for a project" }, { "info": { "name": "Toggle the Environment With `name` Off", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/environments/:name/off", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Removes this environment from the list of available environments for projects to use" } ] }, { "info": { "name": "Change Requests", "type": "folder" }, "items": [ { "info": { "name": "Retrieves Change Request Configuration for a Project", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/config", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nGiven a projectId, this endpoint will retrieve change request configuration for the project" }, { "info": { "name": "Updates Change Request Configuration for an Environment in the Project", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/environments/:environment/change-requests/config", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nThis 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." }, { "info": { "name": "Get Scheduled Change Requests Matching a Query.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/scheduled", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis endpoint retrieves basic information about all scheduled change requests that match the search criteria provided in the query parameters. The endpoint will return any change request that matches one or more of the provided parameters. If you use no query parameters, you'll get an empty list.\n\nFor instance, to find all the scheduled change requests that either touch feature `MyFeature` or strategy `0D198067-7D55-460C-9EC7-DB86E3AE261A`, you would use the query string " }, { "info": { "name": "Create/add Change to a Change Request", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/environments/:environment/change-requests", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nGiven a change request exists, this endpoint will attempt to add a change to\n\nan existing change request for the user. If a change request does not exist,\n\nit will attempt to create one." }, { "info": { "name": "Retrieves Number of Project Change Requests in Each State", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/count", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis endpoint will retrieve the number of project change requests that are: approved, applied, rejected, scheduled or awaiting review" }, { "info": { "name": "Retrieves Pending Change Requests in Configured Environments", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/open", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis endpoint will retrieve the pending change requests in the configured environments for the project, for the current user performing the request." }, { "info": { "name": "Retrieves Pending Change Requests in Configured Environments", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/pending", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis endpoint will retrieve the pending change requests in the configured environments for the project, for the current user performing the request." }, { "info": { "name": "Retrieves All Change Requests for a Project", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis 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." }, { "info": { "name": "Retrieves All Pending Change Requests Referencing a Feature in the Project", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/pending/:featureName", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis endpoint will retrieve all pending change requests (change requests with a status of Draft | In review | Approved) referencing the given feature flag name." }, { "info": { "name": "Retrieves One Change Request by ID", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/:id", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis endpoint will retrieve one change request if it matches the provided id." }, { "info": { "name": "Deletes a Change Request by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/:id", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis endpoint will delete one change request if it matches the provided id." }, { "info": { "name": "Edits a Single Change in a Change Request", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/:changeRequestId/changes/:changeId", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "changeRequestId", "value": "", "type": "path" }, { "name": "changeId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nThis endpoint will edit one change from a change request if it matches the provided id. The edit removes previous change and inserts a new one. You\n\nshould not rely on the changeId for subsequent edits and always check the most recent changeId." }, { "info": { "name": "Discards a Change From a Change Request by Change ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/:changeRequestId/changes/:changeId", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "changeRequestId", "value": "", "type": "path" }, { "name": "changeId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis endpoint will discard one change from a change request if it matches the provided id." }, { "info": { "name": "This Endpoint Will Update the State of a Change Request", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/:id/state", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis endpoint will update the state of a change request if the business rules allow it. The state can be one of the following: Draft, In review, Approved, Cancelled, Applied. In order to be approved, the change request must have at least one change and the number of approvals must be greater than or equal to the number of approvals required for the environment.\n\nOnce a change request has been approved, it can be applied. Once a change request has been applied, it cannot b" }, { "info": { "name": "This Endpoint Will Update the Custom Title of a Change Request", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/:id/title", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nChange requests get a default title e.g. Change Request #1. This endpoint allows to make the title\n\nmore meaningful and describe the intent behind the Change Request" }, { "info": { "name": "This Endpoint Fetches the Requested Approvers of a Change Request", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/:id/approvers", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nChange requests can have requests for review from users. This endpoint fetches the list of requested reviewers for a change request." }, { "info": { "name": "This Endpoint Will Update the Reviewers of a Change Request", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/:id/approvers", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nChange requests can have requests for review from users. This endpoint allows to add or remove reviewers from a change request. The maximum number of reviewers is 10." }, { "info": { "name": "This Endpoint Will Add a Comment to a Change Request", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/:id/comments", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nThis endpoint will add a comment to a change request for the user making the request." }, { "info": { "name": "This Endpoint Will Return Users Available to Review/approve This Change Request", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/change-requests/available-reviewers/:environment", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nThis endpoint will list users available to approve a change request in this project." }, { "info": { "name": "Search Change Requests", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/search/change-requests", "params": [ { "name": "createdBy", "value": "", "type": "query", "description": "Filter by change request creator user ID" }, { "name": "requestedApproverId", "value": "", "type": "query", "description": "Filter by requested approver user ID" }, { "name": "state", "value": "", "type": "query", "description": "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." }, { "name": "offset", "value": "", "type": "query", "description": "The number of change requests to skip when returning a page. By default it is set to 0." }, { "name": "limit", "value": "", "type": "query", "description": "The number of change requests to return in a page. By default it is set to 50. The maximum is 1000." } ] }, "docs": "**Enterprise feature**\n\nSearch and filter change requests by creator and approver." } ] }, { "info": { "name": "Playground", "type": "folder" }, "items": [ { "info": { "name": "Evaluate an Unleash Context Against a Change Request Preview.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/playground/change-request/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nUse 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." }, { "info": { "name": "Evaluate an Unleash Context Against a Set of Environments and Projects.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/playground", "body": { "type": "json", "data": "{}" } }, "docs": "Deprecated. Will be removed in the next Unleash major update. Use the provided `context`, `environment`, and `projects` to evaluate toggles on this Unleash instance. Returns a list of all toggles that match the parameters and what they evaluate to. The response also contains the input parameters that were provided." }, { "info": { "name": "Batch Evaluate an Unleash Context Against a Set of Environments and Projects.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/playground/advanced", "body": { "type": "json", "data": "{}" } }, "docs": "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." } ] }, { "info": { "name": "Service Accounts", "type": "folder" }, "items": [ { "info": { "name": "List Service Accounts.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/service-account" }, "docs": "**Enterprise feature**\n\nReturns the list of all service accounts." }, { "info": { "name": "Create a Service Account.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/service-account", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nCreates a new service account." }, { "info": { "name": "Update a Service Account.", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/service-account/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nUpdates an existing service account identified by its id." }, { "info": { "name": "Delete a Service Account.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/service-account/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nDeletes an existing service account identified by its id." }, { "info": { "name": "List All Tokens for a Service Account.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/service-account/:id/token", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nReturns the list of all tokens for a service account identified by the id." }, { "info": { "name": "Create a Token for a Service Account.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/service-account/:id/token", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nCreates a new token for the service account identified by the id." }, { "info": { "name": "Delete a Token for a Service Account.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/service-account/:id/token/:tokenId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "tokenId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nDeletes a token for the service account identified both by the service account's id and the token's id." } ] }, { "info": { "name": "Import/Export", "type": "folder" }, "items": [ { "info": { "name": "Export Feature Flags From an Environment", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/features-batch/export", "body": { "type": "json", "data": "{}" } }, "docs": "Exports all features listed in the `features` property from the environment specified in the request body. If set to `true`, the `downloadFile` property will let you download a file with the exported data. Otherwise, the export data is returned directly as JSON. Refer to the documentation for more information about [Unleash's export functionality](https://docs.getunleash.io/concepts/import-export#export-feature-flags)." }, { "info": { "name": "Validate Feature Import Data", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/features-batch/validate", "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Import Feature Flags", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/features-batch/import", "body": { "type": "json", "data": "{}" } }, "docs": "[Import feature flags](https://docs.getunleash.io/concepts/import-export#import-feature-flags) into a specific project and environment." } ] }, { "info": { "name": "Instance Admin", "type": "folder" }, "items": [ { "info": { "name": "Get All Login Events.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/logins" }, "docs": "**Enterprise feature**\n\nReturns **all** login events in the Unleash system. You can optionally get them in CSV format by specifying the `Accept` header as `text/csv`." }, { "info": { "name": "Validates the Unleash License.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/license/check" }, "docs": "**Enterprise feature**\n\nValidates the Unleash license." }, { "info": { "name": "Reads the Unleash License.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/license" }, "docs": "**Enterprise feature**\n\nReads the Unleash license. Only available for self-hosted Enterprise customers." }, { "info": { "name": "Set a New Unleash License.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/license", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nSet a new Unleash license. Only available for self-hosted Enterprise customers." }, { "info": { "name": "Instance Usage Statistics", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/instance-admin/statistics/csv" }, "docs": "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." }, { "info": { "name": "Instance Usage Statistics", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/instance-admin/statistics" }, "docs": "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." } ] }, { "info": { "name": "Banners", "type": "folder" }, "items": [ { "info": { "name": "Get All Banners.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/banners" }, "docs": "**Enterprise feature**\n\nReturns a list of all configured banners." }, { "info": { "name": "Create a Banner.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/banners", "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nCreates a new banner." }, { "info": { "name": "Update a Banner.", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/banners/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nUpdates an existing banner identified by its id." }, { "info": { "name": "Delete a Banner.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/banners/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nDeletes an existing banner identified by its id." }, { "info": { "name": "Enables a Banner.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/banners/:id/on", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nEnables an existing banner, identified by its id." }, { "info": { "name": "Disables a Banner.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/banners/:id/off", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nDisables an existing banner, identified by its id." } ] }, { "info": { "name": "Release Templates", "type": "folder" }, "items": [ { "info": { "name": "Get All Release Templates.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/release-plan-templates" }, "docs": "**Enterprise feature**\n\nReturns a list of all release templates." }, { "info": { "name": "Create a Release Template.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/release-plan-templates" }, "docs": "**Enterprise feature**\n\nCreates and returns a release template." }, { "info": { "name": "Get a Release Template by Its Id.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/release-plan-templates/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nFinds and returns a release template by the provided id." }, { "info": { "name": "Updates a Release Template by Its Id.", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/release-plan-templates/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nFinds and updates a release template by the provided id. Will delete existing milestones and create new ones from the body" }, { "info": { "name": "Deletes a Release Template by Its Id.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/release-plan-templates/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nFinds and deletes a release template by the provided id." }, { "info": { "name": "Archives a Release Template by Its Id.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/release-plan-templates/archive/:templateId", "params": [ { "name": "templateId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nFinds and archives a release template by the provided id." }, { "info": { "name": "Adds a Milestone to a Release Template.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/release-plan-templates/:templateId/milestones", "params": [ { "name": "templateId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nFinds release template identified by its id and adds a milestone" }, { "info": { "name": "Updates Existing Milestone", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/release-plan-templates/:templateId/milestones/:milestoneId", "params": [ { "name": "templateId", "value": "", "type": "path" }, { "name": "milestoneId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nFinds milestone by id, and updates to body included in request" }, { "info": { "name": "Removes an Existing Milestone", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/release-plan-templates/:templateId/milestones/:milestoneId", "params": [ { "name": "templateId", "value": "", "type": "path" }, { "name": "milestoneId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nDeletes an existing milestone and all attached strategies beneath it" }, { "info": { "name": "Adds a Strategy to a Milestone.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/release-plan-templates/:templateId/milestones/:milestoneId/strategies", "params": [ { "name": "templateId", "value": "", "type": "path" }, { "name": "milestoneId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nFinds milestone identified by its id and adds a strategy." }, { "info": { "name": "Updates a Strategy Attached to a Milestone", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/release-plan-templates/:templateId/milestones/:milestoneId/strategies/:strategyId", "params": [ { "name": "templateId", "value": "", "type": "path" }, { "name": "milestoneId", "value": "", "type": "path" }, { "name": "strategyId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nOverwrites existing strategy configuration for the strategy referenced by the id" }, { "info": { "name": "Removes a Strategy Attached to a Milestone", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/release-plan-templates/:templateId/milestones/:milestoneId/strategies/:strategyId", "params": [ { "name": "templateId", "value": "", "type": "path" }, { "name": "milestoneId", "value": "", "type": "path" }, { "name": "strategyId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nDeletes the milestone strategy" }, { "info": { "name": "Get Release Plans.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/release_plans", "params": [ { "name": "project", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nReturns a list of all release plans for a specific feature flag and environment. Deprecated, please use /release-plans instead." }, { "info": { "name": "Add a Release Plan.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/release_plans", "params": [ { "name": "project", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nAdds a release plan to a specific feature flag and environment. Deprecated, please use /release-plans instead." }, { "info": { "name": "Get Release Plans.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/release-plans", "params": [ { "name": "project", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nReturns a list of all release plans for a specific feature flag and environment." }, { "info": { "name": "Add a Release Plan.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/release-plans", "params": [ { "name": "project", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Enterprise feature**\n\nAdds a release plan to a specific feature flag and environment." }, { "info": { "name": "Remove a Release Plan.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/release_plans/:planId", "params": [ { "name": "project", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" }, { "name": "planId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nRemoves a release plan from a specific feature flag and environment. Deprecated, please use /release-plans/:planId instead." }, { "info": { "name": "Remove a Release Plan.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/release-plans/:planId", "params": [ { "name": "project", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" }, { "name": "planId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nRemoves a release plan from a specific feature flag and environment." }, { "info": { "name": "Start a Release Plan Milestone.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/release_plans/:planId/milestones/:milestoneId/start", "params": [ { "name": "project", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" }, { "name": "planId", "value": "", "type": "path" }, { "name": "milestoneId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nStarts a release plan milestone for a specific feature flag and environment. Deprecated, please use /release-plans/:planId/milestones/:milestoneId/start instead." }, { "info": { "name": "Start a Release Plan Milestone.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:project/features/:featureName/environments/:environment/release-plans/:planId/milestones/:milestoneId/start", "params": [ { "name": "project", "value": "", "type": "path" }, { "name": "featureName", "value": "", "type": "path" }, { "name": "environment", "value": "", "type": "path" }, { "name": "planId", "value": "", "type": "path" }, { "name": "milestoneId", "value": "", "type": "path" } ] }, "docs": "**Enterprise feature**\n\nStarts a release plan milestone for a specific feature flag and environment." } ] }, { "info": { "name": "Operational", "type": "folder" }, "items": [ { "info": { "name": "getInvoices", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/invoices" }, "docs": "**Enterprise feature**\n\nundefined" }, { "info": { "name": "getDetailedInvoices", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/invoices/list" }, "docs": "**Enterprise feature**\n\nundefined" }, { "info": { "name": "Get Instance Readiness Status", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/ready" }, "docs": "This operation returns information about whether this Unleash instance is ready to serve requests or not. Typically used by your deployment orchestrator (e.g. Kubernetes, Docker Swarm, Mesos, et al.)." }, { "info": { "name": "Get Instance Operational Status", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/health" }, "docs": "This operation returns information about whether this Unleash instance is healthy and ready to serve requests or not. Typically used by your deployment orchestrator (e.g. Kubernetes, Docker Swarm, Mesos, et al.)." } ] }, { "info": { "name": "Public signup tokens", "type": "folder" }, "items": [ { "info": { "name": "Validate Signup Token", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/invite/:token/validate", "params": [ { "name": "token", "value": "", "type": "path" } ] }, "docs": "Check whether the provided public sign-up token exists, has not expired and is enabled" }, { "info": { "name": "Add a User Via a Signup Token", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/invite/:token/signup", "params": [ { "name": "token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a user with the viewer root role and link them to the provided signup token" }, { "info": { "name": "Get Public Signup Tokens", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/invite-link/tokens" }, "docs": "Retrieves all existing public signup tokens." }, { "info": { "name": "Create a Public Signup Token", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/invite-link/tokens", "body": { "type": "json", "data": "{}" } }, "docs": "Lets administrators create a invite link to share with colleagues. People that join using the public invite are assigned the `Viewer` role" }, { "info": { "name": "Retrieve a Token", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/invite-link/tokens/:token", "params": [ { "name": "token", "value": "", "type": "path" } ] }, "docs": "Get information about a specific token. The `:token` part of the URL should be the token's secret." }, { "info": { "name": "Update a Public Signup Token", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/invite-link/tokens/:token", "params": [ { "name": "token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update information about a specific token. The `:token` part of the URL should be the token's secret." } ] }, { "info": { "name": "Feature Types", "type": "folder" }, "items": [ { "info": { "name": "Get All Feature Types", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/feature-types" }, "docs": "Retrieves all feature types that exist in this Unleash instance, along with their descriptions and lifetimes." }, { "info": { "name": "Update Feature Type Lifetime", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/feature-types/:id/lifetime", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\nWhen a feature flag type's expected lifetime is changed, this will also cause any feature flags of this t" } ] }, { "info": { "name": "Archive", "type": "folder" }, "items": [ { "info": { "name": "Archives a Feature", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/archive/:featureName", "params": [ { "name": "featureName", "value": "", "type": "path" } ] }, "docs": "This endpoint archives the specified feature." }, { "info": { "name": "Revives a Feature", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/archive/revive/:featureName", "params": [ { "name": "featureName", "value": "", "type": "path" } ] }, "docs": "This endpoint revives the specified feature from archive." }, { "info": { "name": "Deletes a List of Features", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/delete", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint deletes the specified features, that are in archive." }, { "info": { "name": "Revives a List of Features", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/revive", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint revives the specified features." } ] }, { "info": { "name": "Strategies", "type": "folder" }, "items": [ { "info": { "name": "Get All Strategies", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/strategies" }, "docs": "Retrieves all strategy types ([predefined](https://docs.getunleash.io/concepts/activation-strategies \"predefined strategies\") and [custom strategies](https://docs.getunleash.io/concepts/activation-strategies#custom-strategies)) that are defined on this Unleash instance." }, { "info": { "name": "Create a Strategy", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/strategies", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a custom strategy type based on the supplied data." }, { "info": { "name": "Get a Strategy Definition", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/strategies/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Retrieves the definition of the strategy specified in the URL" }, { "info": { "name": "Update a Strategy Type", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/strategies/:name", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified strategy type. Any properties not specified in the request body are left untouched." }, { "info": { "name": "Delete a Strategy", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/strategies/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Deletes the specified strategy definition" }, { "info": { "name": "Deprecate a Strategy", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/strategies/:strategyName/deprecate", "params": [ { "name": "strategyName", "value": "", "type": "path" } ] }, "docs": "Marks the specified strategy as deprecated." }, { "info": { "name": "Reactivate a Strategy", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/strategies/:strategyName/reactivate", "params": [ { "name": "strategyName", "value": "", "type": "path" } ] }, "docs": "Marks the specified strategy as not deprecated. If the strategy wasn't already deprecated, nothing changes." }, { "info": { "name": "Get Strategies That Use a Context Field", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/context/:contextField/strategies", "params": [ { "name": "contextField", "value": "", "type": "path" } ] }, "docs": "Retrieves a list of all strategies that use the specified context field. If the context field doesn't exist, returns an empty list of strategies" }, { "info": { "name": "Get Strategies That Use a Context Field", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/context/:contextField/strategies", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "contextField", "value": "", "type": "path" } ] }, "docs": "This is a beta endpoint and it may change or be removed in the future.\n\nRetrieves a list of all strategies that use the specified context field. If the context field doesn't exist, returns an empty list of strategies" }, { "info": { "name": "Update Strategy Segments", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/segments/strategies", "body": { "type": "json", "data": "{}" } }, "docs": "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." } ] }, { "info": { "name": "Events", "type": "folder" }, "items": [ { "info": { "name": "Get the Most Recent Events From the Unleash Instance or All Events Related to a Project.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/events", "params": [ { "name": "project", "value": "", "type": "query", "description": "The name of the project whose events you want to retrieve" } ] }, "docs": "Returns **the last 100** events from the Unleash instance when called without a query parameter. When called with a `project` parameter, returns **all events** for the specified project.\n\nIf the provided project does not exist, the list of events will be empty." }, { "info": { "name": "Get All Events Related to a Specific Feature Flag.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/events/:featureName", "params": [ { "name": "featureName", "value": "", "type": "path" } ] }, "docs": "Returns all events related to the specified feature flag. If the feature flag does not exist, the list of events will be empty." }, { "info": { "name": "Get a List of All Users That Have Created Events", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/event-creators" }, "docs": "Returns a list of all users that have created events in the system." }, { "info": { "name": "Search for Events", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/search/events", "params": [ { "name": "query", "value": "", "type": "query", "description": "Find events by a free-text search query. The query will be matched against the event data payload (if any)." }, { "name": "id", "value": "", "type": "query", "description": "Filter by event ID using supported operators: IS, IS_ANY_OF." }, { "name": "groupId", "value": "", "type": "query", "description": "Filter by group ID using supported operators: IS, IS_ANY_OF." }, { "name": "feature", "value": "", "type": "query", "description": "Filter by feature name using supported operators: IS, IS_ANY_OF" }, { "name": "project", "value": "", "type": "query", "description": "Filter by projects ID using supported operators: IS, IS_ANY_OF." }, { "name": "type", "value": "", "type": "query", "description": "Filter by event type using supported operators: IS, IS_ANY_OF." }, { "name": "createdBy", "value": "", "type": "query", "description": "Filter by the ID of the event creator, using supported operators: IS, IS_ANY_OF." }, { "name": "from", "value": "", "type": "query", "description": "The starting date of the creation date range in IS:yyyy-MM-dd format" }, { "name": "to", "value": "", "type": "query", "description": "The ending date of the creation date range in IS:yyyy-MM-dd format" }, { "name": "offset", "value": "", "type": "query", "description": "The number of features to skip when returning a page. By default it is set to 0." }, { "name": "limit", "value": "", "type": "query", "description": "The number of feature environments to return in a page. By default it is set to 50. The maximum is 1000." }, { "name": "environment", "value": "", "type": "query", "description": "Filter by environment name using supported operators: IS, IS_ANY_OF." } ] }, "docs": "Allows searching for events that match the query parameter criteria." } ] }, { "info": { "name": "Unknown Flags", "type": "folder" }, "items": [ { "info": { "name": "Get Unknown Flags", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/metrics/unknown-flags" }, "docs": "Returns a list of unknown flag reports from the last 24 hours, if any. Maximum of 1000." } ] }, { "info": { "name": "Personal access tokens", "type": "folder" }, "items": [ { "info": { "name": "Get All Personal Access Tokens (pats) for the Current User.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/user/tokens" }, "docs": "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." }, { "info": { "name": "Create a New Personal Access Token (pat) for the Current User.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/user/tokens", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete a Personal Access Token (pat) for the Current User.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/user/tokens/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "a personal access token id" } ] }, "docs": "Deletes a [personal access token](https://docs.getunleash.io/concepts/api-tokens-and-client-keys#personal-access-tokens) (PAT) belonging to the current user." } ] }, { "info": { "name": "Context", "type": "folder" }, "items": [ { "info": { "name": "Gets Configured Context Fields", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/context", "params": [ { "name": "include", "value": "", "type": "query", "description": "Whether the response should include project-specific or root context fields in addition to the fields in the default response. When querying the root context API, `include=project` will yield a response that includes all project-specific context fields in addition to all root context fields. Conversely, when querying a project-specific context API, using `include=root` will yield a response that includes all root context fields in addition to the project-specific context fields. The other combinations have no effect, because the responses already include those fields. When including project-specific context fields via the root-level API, context fields in private projects the user does not have access to will be omitted." } ] }, "docs": "Returns all configured [Context fields](https://docs.getunleash.io/concepts/unleash-context) that have been created." }, { "info": { "name": "Create a Context Field", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/context", "body": { "type": "json", "data": "{}" } }, "docs": "Endpoint that allows creation of [custom context fields](https://docs.getunleash.io/concepts/unleash-context#custom-context-fields)" }, { "info": { "name": "Gets Context Field", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/context/:contextField", "params": [ { "name": "contextField", "value": "", "type": "path" } ] }, "docs": "Returns specific [context field](https://docs.getunleash.io/concepts/unleash-context) identified by the name in the path" }, { "info": { "name": "Update an Existing Context Field", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/context/:contextField", "params": [ { "name": "contextField", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Endpoint that allows updating a custom context field. Used to toggle stickiness and add/remove legal values for this context field" }, { "info": { "name": "Delete an Existing Context Field", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/context/:contextField", "params": [ { "name": "contextField", "value": "", "type": "path" } ] }, "docs": "Endpoint that allows deletion of a custom context field. Does not validate that context field is not in use, but since context field configuration is stored in a json blob for the strategy, existing strategies are safe." }, { "info": { "name": "Add or Update Legal Value for the Context Field", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/context/:contextField/legal-values", "params": [ { "name": "contextField", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Endpoint that allows adding or updating a single custom context field legal value. If the legal value already exists, it will be updated with the new description" }, { "info": { "name": "Delete Legal Value for the Context Field", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/context/:contextField/legal-values/:legalValue", "params": [ { "name": "contextField", "value": "", "type": "path" }, { "name": "legalValue", "value": "", "type": "path" } ] }, "docs": "Removes the specified custom context field legal value. Does not validate that the legal value is not in use and does not remove usage from constraints that use it." }, { "info": { "name": "Validate a Context Field", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/context/validate", "body": { "type": "json", "data": "{}" } }, "docs": "Check whether the provided data can be used to create a context field. If the data is not valid, returns a 400 status code with the reason why it is not valid." }, { "info": { "name": "Gets Configured Context Fields", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/context", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "include", "value": "", "type": "query", "description": "Whether the response should include project-specific or root context fields in addition to the fields in the default response. When querying the root context API, `include=project` will yield a response that includes all project-specific context fields in addition to all root context fields. Conversely, when querying a project-specific context API, using `include=root` will yield a response that includes all root context fields in addition to the project-specific context fields. The other combinations have no effect, because the responses already include those fields. When including project-specific context fields via the root-level API, context fields in private projects the user does not have access to will be omitted." } ] }, "docs": "This is a beta endpoint and it may change or be removed in the future.\n\nReturns all configured [Context fields](https://docs.getunleash.io/concepts/unleash-context) that have been created." }, { "info": { "name": "Create a Context Field", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/context", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and it may change or be removed in the future.\n\nEndpoint that allows creation of [custom context fields](https://docs.getunleash.io/concepts/unleash-context#custom-context-fields)" }, { "info": { "name": "Gets Context Field", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/context/:contextField", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "contextField", "value": "", "type": "path" } ] }, "docs": "This is a beta endpoint and it may change or be removed in the future.\n\nReturns specific [context field](https://docs.getunleash.io/concepts/unleash-context) identified by the name in the path" }, { "info": { "name": "Update an Existing Context Field", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/context/:contextField", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "contextField", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and it may change or be removed in the future.\n\nEndpoint that allows updating a custom context field. Used to toggle stickiness and add/remove legal values for this context field" }, { "info": { "name": "Delete an Existing Context Field", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/context/:contextField", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "contextField", "value": "", "type": "path" } ] }, "docs": "This is a beta endpoint and it may change or be removed in the future.\n\nEndpoint that allows deletion of a custom context field. Does not validate that context field is not in use, but since context field configuration is stored in a json blob for the strategy, existing strategies are safe." }, { "info": { "name": "Add or Update Legal Value for the Context Field", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/context/:contextField/legal-values", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "contextField", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and it may change or be removed in the future.\n\nEndpoint that allows adding or updating a single custom context field legal value. If the legal value already exists, it will be updated with the new description" }, { "info": { "name": "Delete Legal Value for the Context Field", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/context/:contextField/legal-values/:legalValue", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "contextField", "value": "", "type": "path" }, { "name": "legalValue", "value": "", "type": "path" } ] }, "docs": "This is a beta endpoint and it may change or be removed in the future.\n\nRemoves the specified custom context field legal value. Does not validate that the legal value is not in use and does not remove usage from constraints that use it." }, { "info": { "name": "Validate a Context Field", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/context/validate", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is a beta endpoint and it may change or be removed in the future.\n\nCheck whether the provided data can be used to create a context field. If the data is not valid, returns a 400 status code with the reason why it is not valid." } ] }, { "info": { "name": "Tags", "type": "folder" }, "items": [ { "info": { "name": "List All Tags.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/tags" }, "docs": "List all tags available in Unleash." }, { "info": { "name": "Create a New Tag.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/tags", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new tag with the specified data." }, { "info": { "name": "List All Tags of a Given Type.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/tags/:type", "params": [ { "name": "type", "value": "", "type": "path" } ] }, "docs": "List all tags of a given type. If the tag type does not exist it returns an empty list." }, { "info": { "name": "Get a Tag by Type and Value.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/tags/:type/:value", "params": [ { "name": "type", "value": "", "type": "path" }, { "name": "value", "value": "", "type": "path" } ] }, "docs": "Get a tag by type and value. Can be used to check whether a given tag already exists in Unleash or not." }, { "info": { "name": "Delete a Tag.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/tags/:type/:value", "params": [ { "name": "type", "value": "", "type": "path" }, { "name": "value", "value": "", "type": "path" } ] }, "docs": "Delete a tag by type and value. When a tag is deleted all references to the tag are removed." }, { "info": { "name": "Get All Tag Types", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/tag-types" }, "docs": "Get a list of all available tag types." }, { "info": { "name": "Create a Tag Type", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/tag-types", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new tag type." }, { "info": { "name": "Validate a Tag Type", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/tag-types/validate", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get a Tag Type", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/tag-types/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get a tag type by name." }, { "info": { "name": "Update a Tag Type", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/tag-types/:name", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the configuration for the specified tag type." }, { "info": { "name": "Delete a Tag Type", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/tag-types/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Deletes a tag type. If any features have tags of this type, those tags will be deleted." }, { "info": { "name": "Adds a Tag to the Specified Features", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/tags", "params": [ { "name": "projectId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a tag to a list of features. Create tags if needed." } ] }, { "info": { "name": "Addons", "type": "folder" }, "items": [ { "info": { "name": "Get All Addons and Providers", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/addons" }, "docs": "Retrieve all addons and providers that are defined on this Unleash instance." }, { "info": { "name": "Create a New Addon", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/addons", "body": { "type": "json", "data": "{}" } }, "docs": "Create an addon instance. The addon must use one of the providers available on this Unleash instance." }, { "info": { "name": "Get a Specific Addon", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/addons/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve information about the addon whose ID matches the ID in the request URL." }, { "info": { "name": "Update an Addon", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/addons/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the addon with a specific ID. Any fields in the update object will be updated. Properties that are not included in the update object will not be affected. To empty a property, pass `null` as that property's value.\n\nNote: passing `null` as a value for the description property will set it to an empty string." }, { "info": { "name": "Delete an Addon", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/addons/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete the addon specified by the ID in the request path." }, { "info": { "name": "Get Integration Events for a Specific Integration Configuration.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/addons/:id/events", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "The number of results to return in a page. By default it is set to 50." }, { "name": "offset", "value": "", "type": "query", "description": "The number of results to skip when returning a page. By default it is set to 0." } ] }, "docs": "Returns a list of integration events belonging to a specific integration configuration, identified by its id." } ] }, { "info": { "name": "API tokens", "type": "folder" }, "items": [ { "info": { "name": "Get API Tokens", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/api-tokens" }, "docs": "Retrieves all API tokens that exist in the Unleash instance." }, { "info": { "name": "Create API Token", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/api-tokens", "body": { "type": "json", "data": "{}" } }, "docs": "Create an API token of a specific type: one of client, admin, frontend, backend." }, { "info": { "name": "Get API Tokens by Name", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/api-tokens/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Update API Token", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/api-tokens/:token", "params": [ { "name": "token", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing API token with a new expiry date. The `token` path parameter is the token's `secret`. If the token does not exist, this endpoint returns a 200 OK, but does nothing." }, { "info": { "name": "Delete API Token", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/api-tokens/:token", "params": [ { "name": "token", "value": "", "type": "path" } ] }, "docs": "Deletes an existing API token. The `token` path parameter is the token's `secret`. If the token does not exist, this endpoint returns a 200 OK, but does nothing." } ] }, { "info": { "name": "Dependencies", "type": "folder" }, "items": [ { "info": { "name": "Add a Feature Dependency.", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:child/dependencies", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "child", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a dependency to a parent feature. Each environment will resolve corresponding dependency independently." }, { "info": { "name": "Deletes Feature Dependencies.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:child/dependencies", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "child", "value": "", "type": "path" } ] }, "docs": "Remove dependencies to all parent features." }, { "info": { "name": "Deletes a Feature Dependency.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:child/dependencies/:parent", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "child", "value": "", "type": "path" }, { "name": "parent", "value": "", "type": "path" } ] }, "docs": "Remove a dependency to a parent feature." }, { "info": { "name": "List Parent Options.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:child/parents", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "child", "value": "", "type": "path" } ] }, "docs": "List available parents who have no transitive dependencies." }, { "info": { "name": "List Parent Feature Variants.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/features/:parent/parent-variants", "params": [ { "name": "projectId", "value": "", "type": "path" }, { "name": "parent", "value": "", "type": "path" } ] }, "docs": "List available parent variants across all strategy variants and feature environment variants." }, { "info": { "name": "Check Dependencies Exist.", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/projects/:projectId/dependencies", "params": [ { "name": "projectId", "value": "", "type": "path" } ] }, "docs": "Check if any dependencies exist in this Unleash instance" } ] }, { "info": { "name": "Segments", "type": "folder" }, "items": [ { "info": { "name": "Validates If a Segment Name Exists", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/segments/validate", "body": { "type": "json", "data": "{}" } }, "docs": "Uses the name provided in the body of the request to validate if the given name exists or not" }, { "info": { "name": "Get Strategy Segments", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/segments/strategies/:strategyId", "params": [ { "name": "strategyId", "value": "", "type": "path" } ] }, "docs": "Retrieve all segments that are referenced by the specified strategy. Returns an empty list of segments if the strategy ID doesn't exist." }, { "info": { "name": "Get Strategies That Reference Segment", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/segments/:id/strategies", "params": [ { "name": "id", "value": "", "type": "path", "description": "a segment id" } ] }, "docs": "Retrieve all strategies that reference the specified segment." }, { "info": { "name": "Get a Segment", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/segments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "a segment id" } ] }, "docs": "Retrieves a segment based on its ID." }, { "info": { "name": "Update Segment by ID", "type": "http" }, "http": { "method": "PUT", "url": "https://app.unleash-instance.example.com/api/admin/segments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "a segment id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the content of the segment with the provided payload. Requires `name` and `constraints` to be present. If `project` is not present, it will be set to `null`. Any other fields not specified will be left untouched." }, { "info": { "name": "Deletes a Segment by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.unleash-instance.example.com/api/admin/segments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "a segment id" } ] }, "docs": "Deletes a segment by its id, if not found returns a 409 error" }, { "info": { "name": "Get All Segments", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/segments" }, "docs": "Retrieves all segments that exist in this Unleash instance." }, { "info": { "name": "Create a New Segment", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/segments", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new segment using the payload provided" } ] }, { "info": { "name": "Maintenance", "type": "folder" }, "items": [ { "info": { "name": "Get Maintenance Mode Status", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/maintenance" }, "docs": "Tells you whether maintenance mode is enabled or disabled" }, { "info": { "name": "Enabled/disabled Maintenance Mode", "type": "http" }, "http": { "method": "POST", "url": "https://app.unleash-instance.example.com/api/admin/maintenance", "body": { "type": "json", "data": "{}" } }, "docs": "Lets administrators put Unleash into a mostly read-only mode. While Unleash is in maintenance mode, users can not change any configuration settings" } ] }, { "info": { "name": "Telemetry", "type": "folder" }, "items": [ { "info": { "name": "Get Telemetry Settings", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/telemetry/settings" }, "docs": "Provides the configured settings for [telemetry information collection](https://docs.getunleash.io/topics/data-collection)" } ] }, { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "Search and Filter Features", "type": "http" }, "http": { "method": "GET", "url": "https://app.unleash-instance.example.com/api/admin/search/features", "params": [ { "name": "query", "value": "", "type": "query", "description": "The search query for the feature name or tag" }, { "name": "project", "value": "", "type": "query", "description": "Id of the project where search and filter is performed. The project id can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF." }, { "name": "state", "value": "", "type": "query", "description": "The state of the feature active/stale. The state can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF." }, { "name": "lifecycle", "value": "", "type": "query", "description": "The lifecycle stage of the feature. The stagee can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF." }, { "name": "type", "value": "", "type": "query", "description": "The feature flag type to filter by. The type can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF." }, { "name": "createdBy", "value": "", "type": "query", "description": "The feature flag creator to filter by. The creators can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF." }, { "name": "tag", "value": "", "type": "query", "description": "The list of feature tags to filter by. Feature tag has to specify a type and a value joined with a colon." }, { "name": "segment", "value": "", "type": "query", "description": "The list of segments with operators to filter by. The segment valid operators are INCLUDE, DO_NOT_INCLUDE, INCLUDE_ALL_OF, INCLUDE_ANY_OF, EXCLUDE_IF_ANY_OF, EXCLUDE_ALL." }, { "name": "status", "value": "", "type": "query", "description": "The list of feature environment status to filter by. Feature environment has to specify a name and a status joined with a colon." }, { "name": "offset", "value": "", "type": "query", "description": "The number of features to skip when returning a page. By default it is set to 0." }, { "name": "limit", "value": "", "type": "query", "description": "The number of feature environments to return in a page. By default it is set to 50." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort the results by. By default it is set to \"createdAt\"." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order for the sortBy. By default it is det to \"asc\"." }, { "name": "favoritesFirst", "value": "", "type": "query", "description": "The flag to indicate if the favorite features should be returned first. By default it is set to false." }, { "name": "archived", "value": "", "type": "query", "description": "Whether to get results for archived feature flags or active feature flags. If `IS:true`, Unleash will return only archived flags. If `IS:false`, it will return only active flags." }, { "name": "createdAt", "value": "", "type": "query", "description": "The date the feature was created. The date can be specified with an operator. The supported operators are IS_BEFORE, IS_ON_OR_AFTER." }, { "name": "lastSeenAt", "value": "", "type": "query", "description": "The date the feature was last seen from metrics. The date can be specified with an operator. The supported operators are IS_BEFORE, IS_ON_OR_AFTER." } ] }, "docs": "Search and filter by selected fields." } ] } ], "bundled": true }