Skip to main content

Update an addon

PUT /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

  • id string required

Body

required

addonCreateUpdateSchema

  • provider string required

    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.

  • description string

    A description of the addon.

  • enabled boolean required

    Whether the addon should be enabled or not.

  • parameters objectrequired

    Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose. Consult the documentation for details.

  • events string[] required

    The event types that will trigger this specific addon.

  • projects string[]

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

  • environments string[]

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

Responses

addonSchema

Schema
  • id integer required

    Possible values: >= 1

    The addon's unique identifier.

  • provider string required

    The addon provider, such as "webhook" or "slack".

  • description string nullable required

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

  • enabled boolean required

    Whether the addon is enabled or not.

  • parameters objectrequired

    Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose.

  • events string[] required

    The event types that trigger this specific addon.

  • projects string[]

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

  • environments string[]

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

Loading...