Get all addons and providers

GET

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

GET

/api/admin/addons

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

1 {
2   "addons": [
3     {
4       "id": 27,
5       "provider": "webhook",
6       "description": "This addon posts updates to our internal feature tracking system whenever a feature is created or updated.",
7       "enabled": true,
8       "parameters": {
9         "url": "http://localhost:4242/webhook"
10       },
11       "events": [
12         "feature-created",
13         "feature-updated"
14       ],
15       "projects": [
16         "new-landing-project",
17         "signups-v2"
18       ],
19       "environments": [
20         "development",
21         "production"
22       ]
23     }
24   ],
25   "providers": [
26     {
27       "name": "webhook",
28       "displayName": "Webhook",
29       "documentationUrl": "https://docs.getunleash.io/integrate/webhook",
30       "description": "A Webhook is a generic way to post messages from Unleash to third party services.",
31       "parameters": [
32         {
33           "name": "url",
34           "displayName": "Webhook URL",
35           "type": "url",
36           "required": true,
37           "sensitive": true,
38           "description": "(Required) Unleash will perform a HTTP Post to the specified URL (one retry if first attempt fails)"
39         },
40         {
41           "name": "contentType",
42           "displayName": "Content-Type",
43           "type": "text",
44           "required": false,
45           "sensitive": false,
46           "description": "(Optional) The Content-Type header to use. Defaults to \"application/json\".",
47           "placeholder": "application/json"
48         },
49         {
50           "name": "authorization",
51           "displayName": "Authorization",
52           "type": "text",
53           "required": false,
54           "sensitive": true,
55           "description": "(Optional) The Authorization header to use. Not used if left blank.",
56           "placeholder": ""
57         },
58         {
59           "name": "bodyTemplate",
60           "displayName": "Body template",
61           "type": "textfield",
62           "required": false,
63           "sensitive": false,
64           "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)",
65           "placeholder": "{\n  \"event\": \"{{event.type}}\",\n  \"createdBy\": \"{{event.createdBy}}\",\n  \"featureToggle\": \"{{event.data.name}}\",\n  \"timestamp\": \"{{event.data.createdAt}}\"\n}"
66         }
67       ],
68       "events": [
69         "feature-created",
70         "feature-updated",
71         "feature-archived",
72         "feature-revived",
73         "feature-stale-on",
74         "feature-stale-off",
75         "feature-environment-enabled",
76         "feature-environment-disabled",
77         "feature-strategy-remove",
78         "feature-strategy-update",
79         "feature-strategy-add",
80         "feature-metadata-updated",
81         "feature-variants-updated",
82         "feature-project-change",
83         "feature-tagged",
84         "feature-untagged",
85         "change-request-created",
86         "change-request-discarded",
87         "change-added",
88         "change-discarded",
89         "change-request-approved",
90         "change-request-approval-added",
91         "change-request-cancelled",
92         "change-request-sent-to-review",
93         "change-request-applied"
94       ]
95     },
96     {
97       "name": "new-app",
98       "displayName": "Addon Name",
99       "documentationUrl": "https://docs.getunleash.io/integrate/",
100       "description": "The App for X that can be combined with Unleash.",
101       "tagTypes": [
102         {
103           "name": "tag-name",
104           "description": "A tag used by the X-addon to specify a configuration.",
105           "icon": "S"
106         }
107       ],
108       "parameters": [
109         {
110           "name": "accessToken",
111           "displayName": "Access token",
112           "type": "text",
113           "required": true,
114           "sensitive": true,
115           "description": "(Required)"
116         },
117         {
118           "name": "defaultChannels",
119           "displayName": "Channels",
120           "type": "text",
121           "required": false,
122           "sensitive": false,
123           "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."
124         }
125       ],
126       "events": [
127         "addon-config-created",
128         "feature-created"
129       ]
130     },
131     {
132       "name": "teams",
133       "displayName": "Microsoft Teams",
134       "documentationUrl": "https://docs.getunleash.io/integrate/teams",
135       "description": "Allows Unleash to post updates to Microsoft Teams.",
136       "parameters": [
137         {
138           "name": "url",
139           "displayName": "Microsoft Teams webhook URL",
140           "type": "url",
141           "required": true,
142           "sensitive": true,
143           "description": "(Required)"
144         }
145       ],
146       "events": [
147         "feature-created",
148         "feature-updated",
149         "feature-archived",
150         "feature-revived",
151         "feature-stale-on",
152         "feature-stale-off",
153         "feature-environment-enabled",
154         "feature-environment-disabled",
155         "feature-strategy-remove",
156         "feature-strategy-update",
157         "feature-strategy-add",
158         "feature-metadata-updated",
159         "feature-variants-updated",
160         "feature-project-change"
161       ]
162     },
163     {
164       "name": "datadog",
165       "displayName": "Datadog",
166       "documentationUrl": "https://docs.getunleash.io/integrate/datadog",
167       "description": "Allows Unleash to post updates to Datadog.",
168       "tagTypes": [
169         {
170           "name": "datadog",
171           "description": "All Datadog tags added to a specific feature are sent to datadog event stream.",
172           "icon": "D"
173         }
174       ],
175       "parameters": [
176         {
177           "name": "url",
178           "displayName": "Datadog Events URL",
179           "type": "url",
180           "required": false,
181           "sensitive": false,
182           "description": "Default URL: https://api.datadoghq.com/api/v1/events. Needs to be changed if your're not using the US1 site."
183         },
184         {
185           "name": "apiKey",
186           "displayName": "Datadog API key",
187           "type": "text",
188           "required": true,
189           "sensitive": true,
190           "description": "(Required) API key to connect to Datadog",
191           "placeholder": "j96c23b0f12a6b3434a8d710110bd862"
192         }
193       ],
194       "events": [
195         "feature-created",
196         "feature-updated",
197         "feature-archived",
198         "feature-revived",
199         "feature-stale-on",
200         "feature-stale-off",
201         "feature-environment-enabled",
202         "feature-environment-disabled",
203         "feature-strategy-remove",
204         "feature-strategy-update",
205         "feature-strategy-add",
206         "feature-metadata-updated",
207         "feature-project-change",
208         "feature-variants-updated"
209       ]
210     }
211   ]
212 }

Retrieve all addons and providers that are defined on this Unleash instance.

curl https://app.unleash-instance.example.com/api/admin/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",
      "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"
      ]
    },
    {
      "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"
      ]
    }
  ]
}

Get all addons and providers

Get all addons and providers

Authentication

Response

Errors

Authentication

Response

Errors

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

1	{
2	"addons": [
3	{
4	"id": 27,
5	"provider": "webhook",
6	"description": "This addon posts updates to our internal feature tracking system whenever a feature is created or updated.",
7	"enabled": true,
8	"parameters": {
9	"url": "http://localhost:4242/webhook"
10	},
11	"events": [
12	"feature-created",
13	"feature-updated"
14	],
15	"projects": [
16	"new-landing-project",
17	"signups-v2"
18	],
19	"environments": [
20	"development",
21	"production"
22	]
23	}
24	],
25	"providers": [
26	{
27	"name": "webhook",
28	"displayName": "Webhook",
29	"documentationUrl": "https://docs.getunleash.io/integrate/webhook",
30	"description": "A Webhook is a generic way to post messages from Unleash to third party services.",
31	"parameters": [
32	{
33	"name": "url",
34	"displayName": "Webhook URL",
35	"type": "url",
36	"required": true,
37	"sensitive": true,
38	"description": "(Required) Unleash will perform a HTTP Post to the specified URL (one retry if first attempt fails)"
39	},
40	{
41	"name": "contentType",
42	"displayName": "Content-Type",
43	"type": "text",
44	"required": false,
45	"sensitive": false,
46	"description": "(Optional) The Content-Type header to use. Defaults to \"application/json\".",
47	"placeholder": "application/json"
48	},
49	{
50	"name": "authorization",
51	"displayName": "Authorization",
52	"type": "text",
53	"required": false,
54	"sensitive": true,
55	"description": "(Optional) The Authorization header to use. Not used if left blank.",
56	"placeholder": ""
57	},
58	{
59	"name": "bodyTemplate",
60	"displayName": "Body template",
61	"type": "textfield",
62	"required": false,
63	"sensitive": false,
64	"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)",
65	"placeholder": "{\n \"event\": \"{{event.type}}\",\n \"createdBy\": \"{{event.createdBy}}\",\n \"featureToggle\": \"{{event.data.name}}\",\n \"timestamp\": \"{{event.data.createdAt}}\"\n}"
66	}
67	],
68	"events": [
69	"feature-created",
70	"feature-updated",
71	"feature-archived",
72	"feature-revived",
73	"feature-stale-on",
74	"feature-stale-off",
75	"feature-environment-enabled",
76	"feature-environment-disabled",
77	"feature-strategy-remove",
78	"feature-strategy-update",
79	"feature-strategy-add",
80	"feature-metadata-updated",
81	"feature-variants-updated",
82	"feature-project-change",
83	"feature-tagged",
84	"feature-untagged",
85	"change-request-created",
86	"change-request-discarded",
87	"change-added",
88	"change-discarded",
89	"change-request-approved",
90	"change-request-approval-added",
91	"change-request-cancelled",
92	"change-request-sent-to-review",
93	"change-request-applied"
94	]
95	},
96	{
97	"name": "new-app",
98	"displayName": "Addon Name",
99	"documentationUrl": "https://docs.getunleash.io/integrate/",
100	"description": "The App for X that can be combined with Unleash.",
101	"tagTypes": [
102	{
103	"name": "tag-name",
104	"description": "A tag used by the X-addon to specify a configuration.",
105	"icon": "S"
106	}
107	],
108	"parameters": [
109	{
110	"name": "accessToken",
111	"displayName": "Access token",
112	"type": "text",
113	"required": true,
114	"sensitive": true,
115	"description": "(Required)"
116	},
117	{
118	"name": "defaultChannels",
119	"displayName": "Channels",
120	"type": "text",
121	"required": false,
122	"sensitive": false,
123	"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."
124	}
125	],
126	"events": [
127	"addon-config-created",
128	"feature-created"
129	]
130	},
131	{
132	"name": "teams",
133	"displayName": "Microsoft Teams",
134	"documentationUrl": "https://docs.getunleash.io/integrate/teams",
135	"description": "Allows Unleash to post updates to Microsoft Teams.",
136	"parameters": [
137	{
138	"name": "url",
139	"displayName": "Microsoft Teams webhook URL",
140	"type": "url",
141	"required": true,
142	"sensitive": true,
143	"description": "(Required)"
144	}
145	],
146	"events": [
147	"feature-created",
148	"feature-updated",
149	"feature-archived",
150	"feature-revived",
151	"feature-stale-on",
152	"feature-stale-off",
153	"feature-environment-enabled",
154	"feature-environment-disabled",
155	"feature-strategy-remove",
156	"feature-strategy-update",
157	"feature-strategy-add",
158	"feature-metadata-updated",
159	"feature-variants-updated",
160	"feature-project-change"
161	]
162	},
163	{
164	"name": "datadog",
165	"displayName": "Datadog",
166	"documentationUrl": "https://docs.getunleash.io/integrate/datadog",
167	"description": "Allows Unleash to post updates to Datadog.",
168	"tagTypes": [
169	{
170	"name": "datadog",
171	"description": "All Datadog tags added to a specific feature are sent to datadog event stream.",
172	"icon": "D"
173	}
174	],
175	"parameters": [
176	{
177	"name": "url",
178	"displayName": "Datadog Events URL",
179	"type": "url",
180	"required": false,
181	"sensitive": false,
182	"description": "Default URL: https://api.datadoghq.com/api/v1/events. Needs to be changed if your're not using the US1 site."
183	},
184	{
185	"name": "apiKey",
186	"displayName": "Datadog API key",
187	"type": "text",
188	"required": true,
189	"sensitive": true,
190	"description": "(Required) API key to connect to Datadog",
191	"placeholder": "j96c23b0f12a6b3434a8d710110bd862"
192	}
193	],
194	"events": [
195	"feature-created",
196	"feature-updated",
197	"feature-archived",
198	"feature-revived",
199	"feature-stale-on",
200	"feature-stale-off",
201	"feature-environment-enabled",
202	"feature-environment-disabled",
203	"feature-strategy-remove",
204	"feature-strategy-update",
205	"feature-strategy-add",
206	"feature-metadata-updated",
207	"feature-project-change",
208	"feature-variants-updated"
209	]
210	}
211	]
212	}