Admin APIAddons

Update an addon

View as Markdown

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.

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Path parameters

idstringRequired

Request

addonCreateUpdateSchema
providerstringRequired

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.

enabledbooleanRequired
Whether the addon should be enabled or not.
parametersmap from strings to anyRequired
Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose. Consult the documentation for details.
eventslist of stringsRequired
The event types that will trigger this specific addon.
descriptionstringOptional
A description of the addon.
projectslist of stringsOptional

The projects that this addon will listen to events from. An empty list means it will listen to events from all projects.

environmentslist of stringsOptional

The list of environments that this addon will listen to events from. An empty list means it will listen to events from all environments.

Response

addonSchema
idinteger>=1
The addon's unique identifier.
providerstring
The addon provider, such as "webhook" or "slack".
descriptionstring or null

A description of the addon. null if no description exists.

enabledboolean
Whether the addon is enabled or not.
parametersmap from strings to any
Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose.
eventslist of strings
The event types that trigger this specific addon.
projectslist of strings

The projects that this addon listens to events from. An empty list means it listens to events from all projects.

environmentslist of strings

The list of environments that this addon listens to events from. An empty list means it listens to events from all environments.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
415
Unsupported Media Type Error