Get a specific addon

GET /api/admin/addons/:id

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

Request

Path Parameters

• id string required

Responses

• 200
• 401

---

addonSchema

application/json

Schema

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.

Example (from schema)

{
  "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"
  ]
}

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "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."
}

Loading...