Update an addon
PUT<your-unleash-url>/api/admin/addons/:id
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.
Note: passing null
as a value for the description property will set it to an empty string.
Request
Path Parameters
- application/json
Bodyrequired
datadog
for Datadogslack
for Slackteams
for Microsoft Teamswebhook
for webhooks
The addon provider, such as "webhook" or "slack". This string is case sensitive and maps to the provider's name
property.
The list of all supported providers and their parameters for a specific Unleash instance can be found by making a GET request to the api/admin/addons
endpoint: the providers
property of that response will contain all available providers.
The default set of providers can be found in the addons reference documentation. The default supported options are:
The provider you choose for your addon dictates what properties the parameters
object needs. Refer to the documentation for each provider for more information.
webhook
A description of the addon.
This addon posts updates to our internal feature tracking system whenever a feature is created or updated.
Whether the addon should be enabled or not.
parameters objectrequired
The event types that will trigger this specific addon.
["feature-created","feature-updated"]
The projects that this addon will listen to events from. An empty list means it will listen to events from all projects.
["new-landing-project","signups-v2"]
The list of environments that this addon will listen to events from. An empty list means it will listen to events from all environments.
["development","production"]
Responses
- 200
- 400
- 401
- 403
- 404
- 413
- 415
- application/json
- Schema
- Example (auto)
Schema
The addon's unique identifier.
Possible values: >= 1
27
The addon provider, such as "webhook" or "slack".
webhook
A description of the addon. null
if no description exists.
This addon posts updates to our internal feature tracking system whenever a feature is created or updated.
Whether the addon is enabled or not.
parameters objectrequired
The event types that trigger this specific addon.
["feature-created","feature-updated"]
The projects that this addon listens to events from. An empty list means it listens to events from all projects.
["new-landing-project","signups-v2"]
The list of environments that this addon listens to events from. An empty list means it listens to events from all environments.
["development","production"]
{
"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"
]
}
- application/json
- Schema
- Example (auto)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
ValidationError
A description of what went wrong.
The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "ValidationError",
"message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}
- application/json
- Schema
- Example (auto)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
AuthenticationRequired
A description of what went wrong.
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.
{
"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."
}
- application/json
- Schema
- Example (auto)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NoAccessError
A description of what went wrong.
You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}
- application/json
- Schema
- Example (auto)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NotFoundError
A description of what went wrong.
Could not find the addon with ID "12345".
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NotFoundError",
"message": "Could not find the addon with ID \"12345\"."
}
- application/json
- Schema
- Example (auto)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
ContentTooLarge
A description of what went wrong.
You provided more data than we can handle. Unleash accepts at most X MB.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "ContentTooLarge",
"message": "You provided more data than we can handle. Unleash accepts at most X MB."
}
- application/json
- Schema
- Example (auto)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
ContentTypeerror
A description of what went wrong.
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.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "ContentTypeerror",
"message": "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."
}
Authorization: Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X PUT '<your-unleash-url>/api/admin/addons/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
-d '{
"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"
]
}'