Skip to main content

Get a specific addon

GET <your-unleash-url>/api/admin/addons/:id

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Retrieve information about the addon whose ID matches the ID in the request URL.

Request

Path Parameters

  • id string required
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.

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL
<your-unleash-url>
Security Scheme
apiKey
id — path required
curl / cURL
curl -L -X GET '<your-unleash-url>/api/admin/addons/:id' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'