[BETA] Get all addons for a project

GET

https://app.unleash-instance.example.com/api/admin/projects/:projectId/addons

GET

/api/admin/projects/:projectId/addons

curl https://app.unleash-instance.example.com/api/admin/projects/projectId/addons \
     -H "Authorization: <apiKey>"

{
  "addons": [
    {
      "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"
      ]
    }
  ],
  "providers": [
    {
      "name": "webhook",
      "displayName": "Webhook",
      "documentationUrl": "https://docs.getunleash.io/integrate/webhook",
      "description": "A Webhook is a generic way to post messages from Unleash to third party services.",
      "parameters": [
        {
          "name": "url",
          "displayName": "Webhook URL",
          "type": "url",
          "required": true,
          "sensitive": true,
          "description": "(Required) Unleash will perform a HTTP Post to the specified URL (one retry if first attempt fails)"
        },
        {
          "name": "contentType",
          "displayName": "Content-Type",
          "type": "text",
          "required": false,
          "sensitive": false,
          "description": "(Optional) The Content-Type header to use. Defaults to \"application/json\".",
          "placeholder": "application/json"
        },
        {
          "name": "authorization",
          "displayName": "Authorization",
          "type": "text",
          "required": false,
          "sensitive": true,
          "description": "(Optional) The Authorization header to use. Not used if left blank.",
          "placeholder": ""
        },
        {
          "name": "bodyTemplate",
          "displayName": "Body template",
          "type": "textfield",
          "required": false,
          "sensitive": false,
          "description": "(Optional) You may format the body using a mustache template. If you don't specify anything, the format will be similar to the events format (https://docs.getunleash.io/concepts/events)",
          "placeholder": "{\n  \"event\": \"{{event.type}}\",\n  \"createdBy\": \"{{event.createdBy}}\",\n  \"featureToggle\": \"{{event.data.name}}\",\n  \"timestamp\": \"{{event.data.createdAt}}\"\n}"
        }
      ],
      "events": [
        "feature-created",
        "feature-updated",
        "feature-archived",
        "feature-revived",
        "feature-stale-on",
        "feature-stale-off",
        "feature-environment-enabled",
        "feature-environment-disabled",
        "feature-strategy-remove",
        "feature-strategy-update",
        "feature-strategy-add",
        "feature-metadata-updated",
        "feature-variants-updated",
        "feature-project-change",
        "feature-tagged",
        "feature-untagged",
        "change-request-created",
        "change-request-discarded",
        "change-added",
        "change-discarded",
        "change-request-approved",
        "change-request-approval-added",
        "change-request-cancelled",
        "change-request-sent-to-review",
        "change-request-applied"
      ]
    },
    {
      "name": "new-app",
      "displayName": "Addon Name",
      "documentationUrl": "https://docs.getunleash.io/integrate/",
      "description": "The App for X that can be combined with Unleash.",
      "tagTypes": [
        {
          "name": "tag-name",
          "description": "A tag used by the X-addon to specify a configuration.",
          "icon": "S"
        }
      ],
      "parameters": [
        {
          "name": "accessToken",
          "displayName": "Access token",
          "type": "text",
          "required": true,
          "sensitive": true,
          "description": "(Required)"
        },
        {
          "name": "defaultChannels",
          "displayName": "Channels",
          "type": "text",
          "required": false,
          "sensitive": false,
          "description": "A comma-separated list of channels to post the configured events to. These channels are always notified, regardless of the event type or the presence of a addon tag."
        }
      ],
      "events": [
        "addon-config-created",
        "feature-created"
      ]
    },
    {
      "name": "teams-workflow",
      "displayName": "Microsoft Teams Workflow",
      "documentationUrl": "https://docs.getunleash.io/integrate/teams-workflow",
      "description": "Allows Unleash to post updates to Microsoft Teams through a predefined Workflow",
      "parameters": [
        {
          "name": "url",
          "displayName": "Microsoft Teams Workflow webhook URL",
          "type": "url",
          "required": true,
          "sensitive": true,
          "description": "(Required)"
        }
      ],
      "events": [
        "feature-created",
        "feature-updated",
        "feature-archived",
        "feature-revived",
        "feature-stale-on",
        "feature-stale-off",
        "feature-environment-enabled",
        "feature-environment-disabled",
        "feature-strategy-remove",
        "feature-strategy-update",
        "feature-strategy-add",
        "feature-metadata-updated",
        "feature-variants-updated",
        "feature-project-change",
        "feature-potentially-stale-on",
        "change-added",
        "change-discarded",
        "change-edited",
        "change-request-applied",
        "change-request-approval-added",
        "change-request-approved",
        "change-request-cancelled",
        "change-request-created",
        "change-request-discarded",
        "change-request-rejected",
        "change-request-sent-to-review",
        "change-request-scheduled",
        "change-request-scheduled-application-success",
        "change-request-scheduled-application-failure",
        "change-request-schedule-suspended",
        "release-plan-progressions-paused",
        "release-plan-progressions-resumed"
      ]
    },
    {
      "name": "teams",
      "displayName": "Microsoft Teams",
      "documentationUrl": "https://docs.getunleash.io/integrate/teams",
      "description": "Allows Unleash to post updates to Microsoft Teams.",
      "parameters": [
        {
          "name": "url",
          "displayName": "Microsoft Teams webhook URL",
          "type": "url",
          "required": true,
          "sensitive": true,
          "description": "(Required)"
        }
      ],
      "events": [
        "feature-created",
        "feature-updated",
        "feature-archived",
        "feature-revived",
        "feature-stale-on",
        "feature-stale-off",
        "feature-environment-enabled",
        "feature-environment-disabled",
        "feature-strategy-remove",
        "feature-strategy-update",
        "feature-strategy-add",
        "feature-metadata-updated",
        "feature-variants-updated",
        "feature-project-change"
      ],
      "deprecated": "This plugin is deprecated due to Microsoft no longer supporting direct incoming webhooks. Use teams-workflow instead"
    },
    {
      "name": "datadog",
      "displayName": "Datadog",
      "documentationUrl": "https://docs.getunleash.io/integrate/datadog",
      "description": "Allows Unleash to post updates to Datadog.",
      "tagTypes": [
        {
          "name": "datadog",
          "description": "All Datadog tags added to a specific feature are sent to datadog event stream.",
          "icon": "D"
        }
      ],
      "parameters": [
        {
          "name": "url",
          "displayName": "Datadog Events URL",
          "type": "url",
          "required": false,
          "sensitive": false,
          "description": "Default URL: https://api.datadoghq.com/api/v1/events. Needs to be changed if your're not using the US1 site."
        },
        {
          "name": "apiKey",
          "displayName": "Datadog API key",
          "type": "text",
          "required": true,
          "sensitive": true,
          "description": "(Required) API key to connect to Datadog",
          "placeholder": "j96c23b0f12a6b3434a8d710110bd862"
        }
      ],
      "events": [
        "feature-created",
        "feature-updated",
        "feature-archived",
        "feature-revived",
        "feature-stale-on",
        "feature-stale-off",
        "feature-environment-enabled",
        "feature-environment-disabled",
        "feature-strategy-remove",
        "feature-strategy-update",
        "feature-strategy-add",
        "feature-metadata-updated",
        "feature-project-change",
        "feature-variants-updated"
      ]
    }
  ]
}

[BETA] This API is in beta state, which means it may change or be removed in the future.

Retrieve the addons that belong to this project, along with the providers that are available on this Unleash instance.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Path parameters

projectIdstringRequired

Response

addonsSchema

addonslist of objects

All the addons that exist on this instance of Unleash.

providerslist of objects

A list of all available addon providers, along with their parameters and descriptions.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error