Skip to main content

Get all addons and providers

GET /api/admin/addons

Retrieve all addons and providers that are defined on this Unleash instance.

Request​

Responses

addonsSchema

Schema
  • addons object[]required

    All the addons that exist on this instance of Unleash.

  • Array [
  • 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.

  • ]
  • providers object[]required

    A list of all available addon providers, along with their parameters and descriptions.

  • Array [
  • name string required

    The name of the addon type. When creating new addons, this goes in the payload's type field.

  • displayName string required

    The addon type's name as it should be displayed in the admin UI.

  • documentationUrl string required

    A URL to where you can find more information about using this addon type.

  • description string required

    A description of the addon type.

  • howTo string

    A long description of how to use this addon type. This will be displayed on the top of configuration page. Can contain markdown.

  • tagTypes object[]

    A list of Unleash tag types that this addon uses. These tags will be added to the Unleash instance when an addon of this type is created.

  • Array [
  • name string required

    The name of the tag type.

  • description string

    The description of the tag type.

  • icon string nullable

    The icon of the tag type.

  • ]
  • parameters object[]

    The addon provider's parameters. Use these to configure an addon of this provider type. Items with required: true must be provided.

  • Array [
  • name string required

    The name of the parameter as it is used in code. References to this parameter should use this value.

  • displayName string required

    The name of the parameter as it is shown to the end user in the Admin UI.

  • type string required

    The type of the parameter. Corresponds roughly to HTML input field types. Multi-line inut fields are indicated as textfield (equivalent to the HTML textarea tag).

  • description string

    A description of the parameter. This should explain to the end user what the parameter is used for.

  • placeholder string

    The default value for this parameter. This value is used if no other value is provided.

  • required boolean required

    Whether this parameter is required or not. If a parameter is required, you must give it a value when you create the addon. If it is not required it can be left out. It may receive a default value in those cases.

  • sensitive boolean required

    Indicates whether this parameter is sensitive or not. Unleash will not return sensitive parameters to API requests. It will instead use a number of asterisks to indicate that a value is set, e.g. "******". The number of asterisks does not correlate to the parameter's value.

  • ]
  • events string[]

    All the event types that are available for this addon provider.

  • installation object

    The installation configuration for this addon type.

  • url string required

    A URL to where the addon configuration should redirect to install addons of this type.

  • title string

    The title of the installation configuration. This will be displayed to the user when installing addons of this type.

  • helpText string

    The help text of the installation configuration. This will be displayed to the user when installing addons of this type.

  • alerts object[]

    A list of alerts to display to the user when installing addons of this type.

  • Array [
  • type string required

    Possible values: [success, info, warning, error]

    The type of alert. This determines the color of the alert.

  • text string required

    The text of the alert. This is what will be displayed to the user.

  • ]
  • deprecated string

    This should be used to inform the user that this addon type is deprecated and should not be used. Deprecated addons will show a badge with this information on the UI.

  • ]
Loading...