Get all addons and providers

GET

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

GET

/api/admin/addons

1 import requests
2 
3 url = "https://app.unleash-instance.example.com/api/admin/addons"
4 
5 headers = {"Authorization": "<apiKey>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

Try it

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/docs/addons/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 similar to the events format (https://docs.getunleash.io/api/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": "slack",
98       "displayName": "Slack",
99       "documentationUrl": "https://docs.getunleash.io/docs/addons/slack",
100       "description": "Allows Unleash to post updates to Slack.",
101       "tagTypes": [
102         {
103           "name": "slack",
104           "description": "Slack tag used by the slack-addon to specify the slack channel.",
105           "icon": "S"
106         }
107       ],
108       "parameters": [
109         {
110           "name": "url",
111           "displayName": "Slack webhook URL",
112           "type": "url",
113           "required": true,
114           "sensitive": true,
115           "description": "(Required)"
116         },
117         {
118           "name": "username",
119           "displayName": "Username",
120           "type": "text",
121           "required": false,
122           "sensitive": false,
123           "description": "The username to use when posting messages to slack. Defaults to \"Unleash\".",
124           "placeholder": "Unleash"
125         },
126         {
127           "name": "emojiIcon",
128           "displayName": "Emoji Icon",
129           "type": "text",
130           "required": false,
131           "sensitive": false,
132           "description": "The emoji_icon to use when posting messages to slack. Defaults to \":unleash:\".",
133           "placeholder": ":unleash:"
134         },
135         {
136           "name": "defaultChannel",
137           "displayName": "Default channel",
138           "type": "text",
139           "required": true,
140           "sensitive": false,
141           "description": "(Required) Default channel to post updates to if not specified in the slack-tag"
142         }
143       ],
144       "events": [
145         "feature-created",
146         "feature-updated",
147         "feature-archived",
148         "feature-revived",
149         "feature-stale-on",
150         "feature-stale-off",
151         "feature-environment-enabled",
152         "feature-environment-disabled",
153         "feature-strategy-remove",
154         "feature-strategy-update",
155         "feature-strategy-add",
156         "feature-metadata-updated",
157         "feature-variants-updated",
158         "feature-project-change"
159       ]
160     },
161     {
162       "name": "teams",
163       "displayName": "Microsoft Teams",
164       "documentationUrl": "https://docs.getunleash.io/docs/addons/teams",
165       "description": "Allows Unleash to post updates to Microsoft Teams.",
166       "parameters": [
167         {
168           "name": "url",
169           "displayName": "Microsoft Teams webhook URL",
170           "type": "url",
171           "required": true,
172           "sensitive": true,
173           "description": "(Required)"
174         }
175       ],
176       "events": [
177         "feature-created",
178         "feature-updated",
179         "feature-archived",
180         "feature-revived",
181         "feature-stale-on",
182         "feature-stale-off",
183         "feature-environment-enabled",
184         "feature-environment-disabled",
185         "feature-strategy-remove",
186         "feature-strategy-update",
187         "feature-strategy-add",
188         "feature-metadata-updated",
189         "feature-variants-updated",
190         "feature-project-change"
191       ]
192     },
193     {
194       "name": "datadog",
195       "displayName": "Datadog",
196       "documentationUrl": "https://docs.getunleash.io/docs/addons/datadog",
197       "description": "Allows Unleash to post updates to Datadog.",
198       "tagTypes": [
199         {
200           "name": "datadog",
201           "description": "All Datadog tags added to a specific feature are sent to datadog event stream.",
202           "icon": "D"
203         }
204       ],
205       "parameters": [
206         {
207           "name": "url",
208           "displayName": "Datadog Events URL",
209           "type": "url",
210           "required": false,
211           "sensitive": false,
212           "description": "Default URL: https://api.datadoghq.com/api/v1/events. Needs to be changed if your're not using the US1 site."
213         },
214         {
215           "name": "apiKey",
216           "displayName": "Datadog API key",
217           "type": "text",
218           "required": true,
219           "sensitive": true,
220           "description": "(Required) API key to connect to Datadog",
221           "placeholder": "j96c23b0f12a6b3434a8d710110bd862"
222         }
223       ],
224       "events": [
225         "feature-created",
226         "feature-updated",
227         "feature-archived",
228         "feature-revived",
229         "feature-stale-on",
230         "feature-stale-off",
231         "feature-environment-enabled",
232         "feature-environment-disabled",
233         "feature-strategy-remove",
234         "feature-strategy-update",
235         "feature-strategy-add",
236         "feature-metadata-updated",
237         "feature-project-change",
238         "feature-variants-updated"
239       ]
240     }
241   ]
242 }

Retrieve all addons and providers that are defined 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

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.

Authentication

Response

Errors