Create a new addon

POST 
<your-unleash-url>/api/admin/addons

Create an addon instance. The addon must use one of the providers available on this Unleash instance.

Request

Responses

200

addonSchema

400

The request data does not match what we expect.

401

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

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

413

The request body is larger than what we accept. By default we only accept bodies of 100kB or less

415

The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.

Authorization: Authorization

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/admin/addons' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
-d '{
  "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"
  ]
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Body required

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

ResponseClear

Click the Send API Request button above and see the response here!