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 stringrequired

Responses

200

addonSchema

application/json

Schema

Schema

id integerrequired
The addon's unique identifier.
Possible values: >= 1
Example: 27
provider stringrequired
The addon provider, such as "webhook" or "slack".
Example: webhook
description stringnullablerequired
A description of the addon. null if no description exists.
Example: This addon posts updates to our internal feature tracking system whenever a feature is created or updated.
enabled booleanrequired

Whether the addon is enabled or not.

parameters

object

required

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

property name* any

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

Example: {"url":"http://localhost:4242/webhook"}
events string[]required
The event types that trigger this specific addon.
Example: ["feature-created","feature-updated"]
projects string[]
The projects that this addon listens to events from. An empty list means it listens to events from all projects.
Example: ["new-landing-project","signups-v2"]
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: ["development","production"]

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

401

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
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: 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.

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...