Unleash Unstable API
Experimental endpoints that may change or disappear at any time.
OpenAPI Specification
openapi: 3.0.3
info:
title: Unleash Admin Addons Unstable API
version: 7.4.1
description: Create, update, and delete [Unleash addons](https://docs.getunleash.io/addons).
servers:
- url: https://app.unleash-instance.example.com
description: Your Unleash instance (replace with your actual URL)
security:
- apiKey: []
- bearerToken: []
tags:
- name: Unstable
description: Experimental endpoints that may change or disappear at any time.
paths:
/api/admin/projects/archive/{projectId}:
post:
tags:
- Unstable
summary: Archive Project
description: '**Enterprise feature**
Archive the provided project. All feature flags in the project must be archived before you can archive the project.'
operationId: archiveProject
responses:
'200':
description: This response has no body.
'400':
description: The request data does not match what we expect.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: ValidationError
description: The name of the error kind
message:
type: string
example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].
description: A description of what went wrong.
'401':
description: Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: AuthenticationRequired
description: The name of the error kind
message:
type: string
example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.
description: A description of what went wrong.
'403':
description: The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: NoAccessError
description: The name of the error kind
message:
type: string
example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
description: A description of what went wrong.
parameters:
- name: projectId
in: path
required: true
schema:
type: string
/api/admin/projects/revive/{projectId}:
post:
tags:
- Unstable
summary: Revive Project
description: '**Enterprise feature**
Revive the specified project from the archive.'
operationId: reviveProject
responses:
'200':
description: This response has no body.
'400':
description: The request data does not match what we expect.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: ValidationError
description: The name of the error kind
message:
type: string
example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].
description: A description of what went wrong.
'401':
description: Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: AuthenticationRequired
description: The name of the error kind
message:
type: string
example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.
description: A description of what went wrong.
'403':
description: The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: NoAccessError
description: The name of the error kind
message:
type: string
example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
description: A description of what went wrong.
parameters:
- name: projectId
in: path
required: true
schema:
type: string
/api/admin/metrics/connection:
get:
tags:
- Unstable
operationId: getConnectionsForPeriod
summary: Get Aggregated Metered Connections for a Given Time Period.
description: '**Enterprise feature**
Gets metered connections count for the selected period, either aggregated by day or by month.'
parameters:
- name: grouping
in: query
required: true
schema:
type: string
enum:
- daily
- monthly
example: daily
description: Whether to aggregate the data by month or by day
- name: from
schema:
type: string
format: date
example: '2024-01-01'
description: The starting date of the traffic data usage search in IS:yyyy-MM-dd format
in: query
required: true
- name: to
schema:
type: string
example: '2024-01-31'
format: date
description: The starting date of the traffic data usage search in IS:yyyy-MM-dd format
in: query
required: true
responses:
'200':
description: meteredConnectionsSchema
content:
application/json:
schema:
$ref: '#/components/schemas/meteredConnectionsSchema'
/api/admin/metrics/request:
get:
tags:
- Unstable
operationId: getRequestsForPeriod
summary: Get Aggregated Metered Requests for a Given Time Period.
description: '**Enterprise feature**
Gets metered requests count for the selected period, either aggregated by day or by month.'
parameters:
- name: grouping
in: query
required: true
schema:
type: string
enum:
- daily
- monthly
example: daily
description: Whether to aggregate the data by month or by day
- name: from
schema:
type: string
format: date
example: '2024-01-01'
description: The starting date of the traffic data usage search in IS:yyyy-MM-dd format
in: query
required: true
- name: to
schema:
type: string
example: '2024-01-31'
format: date
description: The starting date of the traffic data usage search in IS:yyyy-MM-dd format
in: query
required: true
responses:
'200':
description: meteredRequestsSchema
content:
application/json:
schema:
$ref: '#/components/schemas/meteredRequestsSchema'
/api/admin/insights:
get:
tags:
- Unstable
operationId: getInstanceInsights
responses:
'200':
description: instanceInsightsSchema
content:
application/json:
schema:
$ref: '#/components/schemas/instanceInsightsSchema'
parameters:
- name: from
schema:
type: string
example: '2024-01-01'
description: The beginning of the date range in yyyy-MM-dd format
in: query
- name: to
schema:
type: string
example: '2024-01-31'
description: The end of the date range in yyyy-MM-dd format
in: query
summary: Get Instance Information
description: '**Enterprise feature**
Gets high level information about the usage of this Unleash instance, including user, project, and flag information.'
/api/admin/email-subscription/{subscription}:
put:
tags:
- Unstable
operationId: subscribeEmailSubscription
responses:
'202':
description: This response has no body.
'401':
description: Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: AuthenticationRequired
description: The name of the error kind
message:
type: string
example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.
description: A description of what went wrong.
'404':
description: The requested resource was not found.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: NotFoundError
description: The name of the error kind
message:
type: string
example: Could not find the addon with ID "12345".
description: A description of what went wrong.
summary: Subscribe to Email Subscription
description: '**Enterprise feature**
Subscribe to email subscription e.g. monthly productivity report. By default everyone is subscribed. This API is mostly used by hosted Unleash.'
parameters:
- name: subscription
in: path
required: true
schema:
type: string
delete:
tags:
- Unstable
operationId: unsubscribeEmailSubscription
responses:
'202':
description: This response has no body.
'401':
description: Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: AuthenticationRequired
description: The name of the error kind
message:
type: string
example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.
description: A description of what went wrong.
'404':
description: The requested resource was not found.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: NotFoundError
description: The name of the error kind
message:
type: string
example: Could not find the addon with ID "12345".
description: A description of what went wrong.
summary: Unsubscribe From Email Subscription
description: '**Enterprise feature**
Unsubscribe from email subscription e.g. monthly productivity report. This API is mostly used by hosted Unleash.'
parameters:
- name: subscription
in: path
required: true
schema:
type: string
/api/admin/licensed-users:
get:
tags:
- Unstable
operationId: getAllLicensedUsers
summary: Retrieves All Licensed Users Data.
description: '**Enterprise feature**
Fetches an array of licensed users with date and count.'
responses:
'200':
description: licensedUsersSchema
content:
application/json:
schema:
$ref: '#/components/schemas/licensedUsersSchema'
/api/client/edge-licensing/heartbeat:
post:
summary: Heartbeat for Enterprise Edge Instances.
description: '**Enterprise feature**
Reports that an Enterprise Edge instance is alive and in use. This is related to billing and usage tracking.'
tags:
- Unstable
operationId: edgeInstanceHeartbeat
responses:
'202':
description: '#/components/schemas/edgeLicenseStateSchema'
content:
application/json:
schema:
$ref: '#/components/schemas/edgeLicenseStateSchema'
'400':
description: The request data does not match what we expect.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: ValidationError
description: The name of the error kind
message:
type: string
example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].
description: A description of what went wrong.
/api/admin/projects/{projectId}/change-requests/actionable:
get:
summary: Get the Number of Change Requests You Can Do Something With
description: '**Enterprise feature**
Returns the number of change requests in this project that your user can move into the next stage by approving or applying them.'
tags:
- Unstable
operationId: getActionableChangeRequests
responses:
'200':
description: actionableChangeRequestsSchema
content:
application/json:
schema:
$ref: '#/components/schemas/actionableChangeRequestsSchema'
parameters:
- name: projectId
in: path
required: true
schema:
type: string
/api/admin/feedback:
get:
tags:
- Unstable
operationId: getFeedback
responses:
'200':
description: feedbackListSchema
content:
application/json:
schema:
$ref: '#/components/schemas/feedbackListSchema'
description: '**Enterprise feature**
Get all feedback events.'
summary: Get All Feedback Events. Limited to 2000 Items.
/feedback:
post:
summary: Submit User Feedback
description: '**Enterprise feature**
Allows users to submit feedback.'
tags:
- Unstable
operationId: provideFeedback
requestBody:
description: provideFeedbackSchema
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/provideFeedbackSchema'
responses:
'200':
description: feedbackSchema
content:
application/json:
schema:
$ref: '#/components/schemas/feedbackSchema'
/api/admin/cdn/tokens:
post:
summary: Create a Cdn Token.
description: '**Enterprise feature**
Creates a new CDN token for the specified Edge instance.'
tags:
- Unstable
operationId: createCDNToken
requestBody:
description: '#/components/schemas/cdnApiTokenSchema'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/cdnApiTokenSchema'
responses:
'202':
description: This response has no body.
get:
summary: Get a Cdn Tokens.
description: '**Enterprise feature**
Retrieves all CDN tokens for the specified Edge instance.'
tags:
- Unstable
operationId: getCDNTokens
responses:
'200':
description: cdnApiTokensSchema
content:
application/json:
schema:
$ref: '#/components/schemas/cdnApiTokensSchema'
/api/admin/scim-settings:
get:
tags:
- Unstable
operationId: getScimSettings
summary: Get SCIM Settings.
description: '**Enterprise feature**
Returns the current settings for SCIM provisioning.'
responses:
'200':
description: '#/components/schemas/scimSettingsSchema'
content:
application/json:
schema:
$ref: '#/components/schemas/scimSettingsSchema'
'401':
description: Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: AuthenticationRequired
description: The name of the error kind
message:
type: string
example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.
description: A description of what went wrong.
post:
tags:
- Unstable
operationId: setScimSettings
summary: Set SCIM Settings.
description: '**Enterprise feature**
Sets new settings for SCIM provisioning.'
requestBody:
description: '#/components/schemas/setScimSettingsSchema'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/setScimSettingsSchema'
responses:
'200':
description: This response has no body.
'400':
description: The request data does not match what we expect.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: ValidationError
description: The name of the error kind
message:
type: string
example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].
description: A description of what went wrong.
'401':
description: Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: AuthenticationRequired
description: The name of the error kind
message:
type: string
example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.
description: A description of what went wrong.
'403':
description: The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: NoAccessError
description: The name of the error kind
message:
type: string
example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
description: A description of what went wrong.
'415':
description: The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: ContentTypeerror
description: The name of the error kind
message:
type: string
example: We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format.
description: A description of what went wrong.
/api/admin/scim-settings/generate-new-token:
post:
tags:
- Unstable
operationId: generateNewToken
summary: Generates a New SCIM API Token.
description: '**Enterprise feature**
Generates a new SCIM API token. Previously generated tokens will be invalidated.'
responses:
'200':
description: '#/components/schemas/scimTokenSchema'
content:
application/json:
schema:
$ref: '#/components/schemas/scimTokenSchema'
'401':
description: Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: AuthenticationRequired
description: The name of the error kind
message:
type: string
example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.
description: A description of what went wrong.
'403':
description: The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: NoAccessError
description: The name of the error kind
message:
type: string
example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
description: A description of what went wrong.
'404':
description: The requested resource was not found.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: NotFoundError
description: The name of the error kind
message:
type: string
example: Could not find the addon with ID "12345".
description: A description of what went wrong.
/api/client/streaming:
get:
tags:
- Unstable
operationId: connect
summary: Connect to the Streaming Api.
description: '**Enterprise feature**
Connects to the client features SSE streaming API.'
responses:
'200':
description: Connected to the streaming API.
'401':
description: Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: AuthenticationRequired
description: The name of the error kind
message:
type: string
example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.
description: A description of what went wrong.
'403':
description: The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: NoAccessError
description: The name of the error kind
message:
type: string
example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
description: A description of what went wrong.
/api/client/delta:
get:
summary: Get Partial Updates (sdk)
description: '**Enterprise feature**
Initially 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'
operationId: getDelta
tags:
- Unstable
responses:
'200':
description: clientFeaturesDeltaSchema
content:
application/json:
schema:
$ref: '#/components/schemas/clientFeaturesDeltaSchema'
/api/admin/streaming/disconnect-all:
post:
tags:
- Unstable
operationId: disconnectAll
summary: Disconnect All Clients.
description: '**Enterprise feature**
Disconnects all streaming clients.'
responses:
'200':
description: This response has no body.
'401':
description: Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c40958a-daac-400e-98fb-3bb438567008
description: The ID of the error instance
name:
type: string
example: AuthenticationRequired
description: The name of the error kind
message:
type: string
example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.
description: A description of what went wrong.
'403':
description: The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
content:
application/json:
schema:
type: object
properties:
id:
type: string
example: 9c
# --- truncated at 32 KB (183 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/unleash/refs/heads/main/openapi/unleash-unstable-api-openapi.yml