Get all addons and providers
GET <your-unleash-url>/api/admin/addons
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Retrieve all addons and providers that are defined on this Unleash instance.
Request
Responses
- 200
- 401
addonsSchema
- application/json
- Schema
- Example (from schema)
Schema
addons object[]required
providers object[]required
{
"addons": [
{
"id": 27,
"provider": "webhook",
"description": "This addon posts updates to our internal feature tracking system whenever a feature is created or updated.",
"enabled": true,
"parameters": {
"url": "http://localhost:4242/webhook"
},
"events": [
"feature-created",
"feature-updated"
],
"projects": [
"new-landing-project",
"signups-v2"
],
"environments": [
"development",
"production"
]
}
],
"providers": [
{
"name": "webhook",
"displayName": "Webhook",
"description": "A Webhook is a generic way to post messages from Unleash to third party services.",
"documentationUrl": "https://docs.getunleash.io/docs/addons/webhook",
"parameters": [
{
"name": "url",
"displayName": "Webhook URL",
"description": "(Required) Unleash will perform a HTTP Post to the specified URL (one retry if first attempt fails)",
"type": "url",
"required": true,
"sensitive": true
},
{
"name": "contentType",
"displayName": "Content-Type",
"placeholder": "application/json",
"description": "(Optional) The Content-Type header to use. Defaults to \"application/json\".",
"type": "text",
"required": false,
"sensitive": false
},
{
"name": "authorization",
"displayName": "Authorization",
"placeholder": "",
"description": "(Optional) The Authorization header to use. Not used if left blank.",
"type": "text",
"required": false,
"sensitive": true
},
{
"name": "bodyTemplate",
"displayName": "Body template",
"placeholder": "{\n \"event\": \"{{event.type}}\",\n \"createdBy\": \"{{event.createdBy}}\",\n \"featureToggle\": \"{{event.data.name}}\",\n \"timestamp\": \"{{event.data.createdAt}}\"\n}",
"description": "(Optional) You may format the body using a mustache template. If you don't specify anything, the format will similar to the events format (https://docs.getunleash.io/reference/api/legacy/unleash/admin/events)",
"type": "textfield",
"required": false,
"sensitive": false
}
],
"events": [
"feature-created",
"feature-updated",
"feature-archived",
"feature-revived",
"feature-stale-on",
"feature-stale-off",
"feature-environment-enabled",
"feature-environment-disabled",
"feature-strategy-remove",
"feature-strategy-update",
"feature-strategy-add",
"feature-metadata-updated",
"feature-variants-updated",
"feature-project-change",
"feature-tagged",
"feature-untagged",
"change-request-created",
"change-request-discarded",
"change-added",
"change-discarded",
"change-request-approved",
"change-request-approval-added",
"change-request-cancelled",
"change-request-sent-to-review",
"change-request-applied"
]
},
{
"name": "slack",
"displayName": "Slack",
"description": "Allows Unleash to post updates to Slack.",
"documentationUrl": "https://docs.getunleash.io/docs/addons/slack",
"parameters": [
{
"name": "url",
"displayName": "Slack webhook URL",
"description": "(Required)",
"type": "url",
"required": true,
"sensitive": true
},
{
"name": "username",
"displayName": "Username",
"placeholder": "Unleash",
"description": "The username to use when posting messages to slack. Defaults to \"Unleash\".",
"type": "text",
"required": false,
"sensitive": false
},
{
"name": "emojiIcon",
"displayName": "Emoji Icon",
"placeholder": ":unleash:",
"description": "The emoji_icon to use when posting messages to slack. Defaults to \":unleash:\".",
"type": "text",
"required": false,
"sensitive": false
},
{
"name": "defaultChannel",
"displayName": "Default channel",
"description": "(Required) Default channel to post updates to if not specified in the slack-tag",
"type": "text",
"required": true,
"sensitive": false
}
],
"events": [
"feature-created",
"feature-updated",
"feature-archived",
"feature-revived",
"feature-stale-on",
"feature-stale-off",
"feature-environment-enabled",
"feature-environment-disabled",
"feature-strategy-remove",
"feature-strategy-update",
"feature-strategy-add",
"feature-metadata-updated",
"feature-variants-updated",
"feature-project-change"
],
"tagTypes": [
{
"name": "slack",
"description": "Slack tag used by the slack-addon to specify the slack channel.",
"icon": "S"
}
]
},
{
"name": "teams",
"displayName": "Microsoft Teams",
"description": "Allows Unleash to post updates to Microsoft Teams.",
"documentationUrl": "https://docs.getunleash.io/docs/addons/teams",
"parameters": [
{
"name": "url",
"displayName": "Microsoft Teams webhook URL",
"description": "(Required)",
"type": "url",
"required": true,
"sensitive": true
}
],
"events": [
"feature-created",
"feature-updated",
"feature-archived",
"feature-revived",
"feature-stale-on",
"feature-stale-off",
"feature-environment-enabled",
"feature-environment-disabled",
"feature-strategy-remove",
"feature-strategy-update",
"feature-strategy-add",
"feature-metadata-updated",
"feature-variants-updated",
"feature-project-change"
]
},
{
"name": "datadog",
"displayName": "Datadog",
"description": "Allows Unleash to post updates to Datadog.",
"documentationUrl": "https://docs.getunleash.io/docs/addons/datadog",
"parameters": [
{
"name": "url",
"displayName": "Datadog Events URL",
"description": "Default URL: https://api.datadoghq.com/api/v1/events. Needs to be changed if your're not using the US1 site.",
"type": "url",
"required": false,
"sensitive": false
},
{
"name": "apiKey",
"displayName": "Datadog API key",
"placeholder": "j96c23b0f12a6b3434a8d710110bd862",
"description": "(Required) API key to connect to Datadog",
"type": "text",
"required": true,
"sensitive": true
}
],
"events": [
"feature-created",
"feature-updated",
"feature-archived",
"feature-revived",
"feature-stale-on",
"feature-stale-off",
"feature-environment-enabled",
"feature-environment-disabled",
"feature-strategy-remove",
"feature-strategy-update",
"feature-strategy-add",
"feature-metadata-updated",
"feature-project-change",
"feature-variants-updated"
],
"tagTypes": [
{
"name": "datadog",
"description": "All Datadog tags added to a specific feature are sent to datadog event stream.",
"icon": "D"
}
]
}
]
}
Authorization information is missing or invalid. Provide a valid API token as the authorization
header, e.g. authorization:*.*.my-admin-token
.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "AuthenticationRequired",
"message": "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."
}
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Request
Request
curl / cURL
curl -L -X GET '<your-unleash-url>/api/admin/addons' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
python / requests
curl -L -X GET '<your-unleash-url>/api/admin/addons' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
go / native
curl -L -X GET '<your-unleash-url>/api/admin/addons' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
nodejs / native
curl -L -X GET '<your-unleash-url>/api/admin/addons' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
ruby / Net::HTTP
curl -L -X GET '<your-unleash-url>/api/admin/addons' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
csharp / httpclient
curl -L -X GET '<your-unleash-url>/api/admin/addons' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
php / cURL
curl -L -X GET '<your-unleash-url>/api/admin/addons' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
java / OkHttp
curl -L -X GET '<your-unleash-url>/api/admin/addons' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
powershell / RestMethod
curl -L -X GET '<your-unleash-url>/api/admin/addons' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'