Create a new addon

POST 
/api/admin/addons

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

Request

application/json

Body

required

addonCreateUpdateSchema

provider stringrequired
The addon provider, such as "webhook" or "slack". This string is case sensitive and maps to the provider's name property.
The list of all supported providers and their parameters for a specific Unleash instance can be found by making a GET request to the api/admin/addons endpoint: the providers property of that response will contain all available providers.
The default set of providers can be found in the addons reference documentation. The default supported options are:
• datadog for Datadog
• slack for Slack
• teams for Microsoft Teams
• webhook for webhooks
The provider you choose for your addon dictates what properties the parameters object needs. Refer to the documentation for each provider for more information.
Example: webhook
description string
A description of the addon.
Example: This addon posts updates to our internal feature tracking system whenever a feature is created or updated.
enabled booleanrequired

Whether the addon should be 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. Consult the documentation for details.

property name* any

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

Example: {"url":"http://localhost:4242/webhook"}
events string[]required
The event types that will trigger this specific addon.
Example: ["feature-created","feature-updated"]
projects string[]
The projects that this addon will listen to events from. An empty list means it will listen to events from all projects.
Example: ["new-landing-project","signups-v2"]
environments string[]
The list of environments that this addon will listen to events from. An empty list means it will listen to events from all environments.
Example: ["development","production"]

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

400

The request data does not match what we expect.

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: ValidationError
message string
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

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

403

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

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: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

413

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

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: ContentTooLarge
message string
A description of what went wrong.
Example: You provided more data than we can handle. Unleash accepts at most X MB.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ContentTooLarge",
  "message": "You provided more data than we can handle. Unleash accepts at most X MB."
}

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.

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: ContentTypeerror
message string
A description of what went wrong.
Example: We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ContentTypeerror",
  "message": "We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format."
}

Loading...