Information about apps
Get a list of apps matching the specified parameters.
string
integer
array<string>
string
string
boolean
array<string>
string
boolean
array<string>
1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"alternate": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"query": {
"template": "<string>",
"type": "<string>",
"name": "<string>"
},
"byKey": {
"template": "<string>",
"type": "<string>",
"name": "<string>"
},
"banners": {
"template": "<string>",
"type": "<string>",
"name": "<string>"
},
"next": [
{
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
],
"prev": [
{
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
]
},
"_embedded": {
"addons": [
{
"_links": {
"self": {
"href": "<string>"
},
"alternate": {
"href": "<string>"
},
"categories": [
{
"href": "<string>"
}
],
"distribution": {
"href": "<string>"
},
"reviews": [
{
"template": "<string>"
}
],
"vendor": {
"href": "<string>"
},
"versions": {
"href": "<string>"
}
},
"_embedded": {
"categories": [
{
"name": "<string>"
}
],
"distribution": {
"bundled": true,
"bundledCloud": true,
"downloads": 67
},
"reviews": {
"averageStars": 23,
"count": 23
}
},
"name": "<string>",
"key": "<string>",
"tagLine": "<string>",
"summary": "<string>",
"status": "private"
}
]
},
"count": 45
}Create a new app.
The associated vendor account must exist prior to the app's creation.
Note that the app's first version should be included in the request body (in _embedded.version).
This resource requires authentication.
AddonLinks
RequiredAddonEmbedded
string
Requiredstring
Requiredstring
Requiredstring
string
Tags
AddonExternalLinks
boolean
Successfully created
string
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
curl --request POST \
--url 'https://marketplace.atlassian.com/rest/2/addons' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json' \
--data '{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"alternate": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"banner": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"categories": [
{
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
],
"logo": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"support": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"titleLogo": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"tokens": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"distribution": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"recommendations": {
"template": "<string>",
"type": "<string>",
"name": "<string>"
},
"vendor": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"versions": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"watch": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"approval": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"edit": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"transition": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"release": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"feedbacks": {
"template": "<string>",
"type": "<string>",
"name": "<string>"
}
},
"_embedded": {
"banner": {
"_links": {
"self": {
"href": "<string>"
},
"image": {
"href": "<string>"
},
"unscaled": {
"href": "<string>"
}
}
},
"logo": {
"_links": {
"self": {
"href": "<string>"
},
"image": {
"href": "<string>"
},
"unscaled": {
"href": "<string>"
}
}
},
"titleLogo": {
"_links": {
"self": {
"href": "<string>"
},
"image": {
"href": "<string>"
},
"unscaled": {
"href": "<string>"
}
}
},
"distribution": {},
"reviews": {
"averageStars": 23,
"count": 23
},
"vendor": {
"_links": {
"self": {
"href": "<string>"
},
"alternate": {
"href": "<string>"
}
},
"_embedded": {},
"name": "<string>",
"verifiedStatus": "flagged",
"programs": {},
"isAtlassian": true
},
"version": {
"_links": {},
"_embedded": {},
"buildNumber": 120,
"name": "<string>",
"status": "private",
"paymentModel": "atlassian",
"release": {
"beta": true,
"supported": true
},
"youtubeId": "<string>",
"vendorLinks": {},
"compatibilities": [
{
"application": "<string>",
"hosting": {}
}
],
"text": {},
"integrationType": "global",
"legacy": {
"vendorLinks": {}
},
"deployment": {},
"cloud": {
"appId": "<string>",
"appEnvironmentId": "<string>",
"appVersionId": "<string>"
}
}
},
"name": "<string>",
"key": "<string>",
"status": "private",
"summary": "<string>",
"tagLine": "<string>",
"tags": {
"category": [
{
"id": "<string>",
"name": "<string>"
}
],
"keywords": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"vendorLinks": {
"issueTracker": "<string>",
"supportTicketSystem": "<string>",
"appStatusPage": "<string>",
"forums": "<string>",
"privacy": "<string>"
},
"enableAtlassianAnswers": true,
"googleAnalyticsId": "<string>",
"legacy": {
"description": "<string>",
"vendorLinks": {
"wiki": "<string>",
"source": "<string>",
"builds": "<string>"
}
},
"marketing": {
"marketingLabels": [
"<string>"
]
},
"statusAfterApproval": "private",
"communityEnabled": true,
"jsdEmbeddedDataKey": "<string>",
"dataCenterReviewIssueKey": "<string>"
}'Get a list of archived apps matching the specified parameters.
string
integer
array<string>
string
string
boolean
array<string>
string
boolean
array<string>
1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/archived' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"alternate": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"prev": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"next": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"_embedded": {
"addons": [
{
"_links": {
"self": {
"href": "<string>"
},
"alternate": {
"href": "<string>"
},
"vendor": {
"href": "<string>"
}
},
"_embedded": {},
"key": "<string>",
"name": "<string>",
"lastModified": "<string>"
}
]
},
"count": 45
}Get a list of archived apps by a specific vendor matching the specified parameters.
integer
Requiredstring
integer
array<string>
string
string
boolean
array<string>
string
boolean
array<string>
1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/archived/vendor/{vendorId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"alternate": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"prev": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"next": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"_embedded": {
"addons": [
{
"_links": {
"self": {
"href": "<string>"
},
"alternate": {
"href": "<string>"
},
"vendor": {
"href": "<string>"
}
},
"_embedded": {},
"key": "<string>",
"name": "<string>",
"lastModified": "<string>"
}
]
},
"count": 45
}Get a list of app banners matching the specified parameters.
string
integer
array<string>
string
string
boolean
array<string>
string
boolean
array<string>
1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/listings/banners' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"alternate": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"prev": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"next": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"_embedded": {
"addons": [
{
"_links": {
"self": {
"href": "<string>"
},
"alternate": {
"href": "<string>"
},
"vendor": {
"href": "<string>"
}
},
"_embedded": {},
"key": "<string>",
"name": "<string>",
"lastModified": "<string>"
}
]
},
"count": 45
}Get a list of apps with names matching a search term. This resource's responses are limited to just a single page of results. Use the app collection resource (/rest/2/addons) for more results.
string
1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/search/brief' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"addons": [
{
"name": "<string>",
"key": "<string>",
"_links": {
"alternate": {
"href": "<string>"
},
"logo": {
"href": "<string>"
}
}
}
]
}Get a list of apps for the specified vendor.
integer
Requiredstring
integer
array<string>
string
string
boolean
array<string>
string
boolean
array<string>
1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/vendor/{vendorId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"alternate": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"query": {
"template": "<string>",
"type": "<string>",
"name": "<string>"
},
"byKey": {
"template": "<string>",
"type": "<string>",
"name": "<string>"
},
"banners": {
"template": "<string>",
"type": "<string>",
"name": "<string>"
},
"next": [
{
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
],
"prev": [
{
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
]
},
"_embedded": {
"addons": [
{
"_links": {
"self": {
"href": "<string>"
},
"alternate": {
"href": "<string>"
},
"categories": [
{
"href": "<string>"
}
],
"distribution": {
"href": "<string>"
},
"reviews": [
{
"template": "<string>"
}
],
"vendor": {
"href": "<string>"
},
"versions": {
"href": "<string>"
}
},
"_embedded": {
"categories": [
{
"name": "<string>"
}
],
"distribution": {
"bundled": true,
"bundledCloud": true,
"downloads": 67
},
"reviews": {
"averageStars": 23,
"count": 23
}
},
"name": "<string>",
"key": "<string>",
"tagLine": "<string>",
"summary": "<string>",
"status": "private"
}
]
},
"count": 45
}Get a specific app.
string
Requiredstring
integer
array<string>
string
string
boolean
array<string>
string
boolean
array<string>
1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"alternate": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"banner": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"categories": [
{
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
],
"logo": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"pricing": [
{
"href": "<string>",
"type": "<string>",
"name": "<string>",
"templated": true
}
],
"support": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"titleLogo": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"tokens": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"distribution": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"recommendations": {
"template": "<string>",
"type": "<string>",
"name": "<string>"
},
"reviews": [
{
"template": "<string>",
"type": "<string>",
"name": "<string>"
}
],
"vendor": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"versions": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"watch": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"approval": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"edit": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"transition": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"release": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"feedbacks": {
"template": "<string>",
"type": "<string>",
"name": "<string>"
}
},
"_embedded": {
"banner": {
"_links": {
"self": {
"href": "<string>"
},
"image": {
"href": "<string>"
},
"unscaled": {
"href": "<string>"
}
}
},
"categories": [
{
"_links": {
"self": {
"href": "<string>"
}
},
"name": "<string>"
}
],
"logo": {
"_links": {
"self": {
"href": "<string>"
},
"image": {
"href": "<string>"
},
"unscaled": {
"href": "<string>"
}
}
},
"titleLogo": {
"_links": {
"self": {
"href": "<string>"
},
"image": {
"href": "<string>"
},
"unscaled": {
"href": "<string>"
}
}
},
"distribution": {
"bundled": true,
"bundledCloud": true,
"downloads": 67,
"totalInstalls": 112,
"totalUsers": 84
},
"reviews": {
"averageStars": 23,
"count": 23
},
"vendor": {
"_links": {
"self": {
"href": "<string>"
},
"alternate": {
"href": "<string>"
}
},
"_embedded": {},
"name": "<string>",
"verifiedStatus": "flagged",
"programs": {},
"isAtlassian": true
},
"version": {
"_links": {},
"_embedded": {},
"buildNumber": 120,
"name": "<string>",
"status": "private",
"paymentModel": "atlassian",
"release": {
"beta": true,
"supported": true
},
"youtubeId": "<string>",
"vendorLinks": {},
"compatibilities": [
{
"application": "<string>",
"hosting": {}
}
],
"text": {},
"static": true,
"deployable": true,
"integrationType": "global",
"legacy": {
"vendorLinks": {}
},
"deployment": {
"server": true,
"cloud": true,
"connect": true,
"autoUpdateAllowed": true,
"permissions": [
{
"_links": {
"alternate": {
"href": "<string>"
}
},
"key": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"dataCenter": true
},
"cloud": {
"appId": "<string>",
"appEnvironmentId": "<string>",
"appVersionId": "<string>"
}
}
},
"name": "<string>",
"key": "<string>",
"status": "private",
"summary": "<string>",
"tagLine": "<string>",
"tags": {
"category": [
{
"id": "<string>",
"name": "<string>"
}
],
"keywords": [
{
"id": "<string>",
"name": "<string>"
}
],
"marketing": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"vendorLinks": {
"issueTracker": "<string>",
"supportTicketSystem": "<string>",
"appStatusPage": "<string>",
"forums": "<string>",
"privacy": "<string>"
},
"enableAtlassianAnswers": true,
"googleAnalyticsId": "<string>",
"legacy": {
"description": "<string>",
"vendorLinks": {
"wiki": "<string>",
"source": "<string>",
"builds": "<string>"
}
},
"marketing": {
"marketingLabels": [
"<string>"
]
},
"lastModified": "<string>",
"codegeist": true,
"statusAfterApproval": "private",
"communityEnabled": true,
"jsdEmbeddedDataKey": "<string>",
"dataCenterReviewIssueKey": "<string>"
}Update a specific app.
The request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.
This resource requires authentication.
string
RequiredThe request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.
array<JsonPatchDocumentation>
string
Requiredstring
Requiredobject
string
Successfully modified
string
1
2
3
curl --request PATCH \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}' \
--user 'email@example.com:<api_token>'Get a specific app approval status. This resource requires authentication.
string
Required1
2
3
4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/approval' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"parent": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"issuePortal": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"status": "approved",
"reason": "<string>"
}Approve, reject or resubmit an app for approval.
Vendors can use this resource to resubmit a previously rejected app for approval. This is done by setting the status field to pending.
Administrators can use this resource to approve or reject an app that is submitted for approval.
This resource requires authentication.
string
RequiredApprovalStatusLinks
string
Requiredstring
Invalid properties
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
curl --request PUT \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/approval' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json' \
--data '{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"parent": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"issuePortal": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"status": "approved",
"reason": "<string>"
}'1
2
3
4
5
6
7
8
9
{
"errors": [
{
"message": "<string>",
"path": "<string>",
"code": "<string>"
}
]
}Get a summary of an app's latest metrics.
string
RequiredSummary information about an app's installation distribution
1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution' \
--header 'Accept: application/json'1
2
3
4
5
6
7
{
"bundled": true,
"bundledCloud": true,
"downloads": 67,
"totalInstalls": 112,
"totalUsers": 84
}Get a specific app's active installation counts over time. This resource requires authentication.
string
RequiredDetailed information about an app's distribution
1
2
3
4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/active' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"series": [
{
"name": "<string>",
"elements": [
{
"date": "<string>",
"count": 63
}
]
}
]
}Get a specific app's active installation counts over time, aggregated by application. This resource requires authentication.
string
RequiredDetailed information about an app's distribution
1
2
3
4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/application' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"series": [
{
"name": "<string>",
"elements": [
{
"date": "<string>",
"count": 63
}
]
}
]
}Get a specific app's active installation counts over time, aggregated by application version. This resource requires authentication.
string
RequiredDetailed information about an app's distribution
1
2
3
4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/application/version' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"series": [
{
"name": "<string>",
"elements": [
{
"date": "<string>",
"count": 63
}
]
}
]
}Get a specific app's active installation counts over time, aggregated by major application version. This resource requires authentication.
string
RequiredDetailed information about an app's distribution
1
2
3
4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/application/version/major' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"series": [
{
"name": "<string>",
"elements": [
{
"date": "<string>",
"count": 63
}
]
}
]
}Get a specific app's active installation counts over time, aggregated by minor application version. This resource requires authentication.
string
RequiredDetailed information about an app's distribution
1
2
3
4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/application/version/minor' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"series": [
{
"name": "<string>",
"elements": [
{
"date": "<string>",
"count": 63
}
]
}
]
}Get a specific app's active installation counts over time, aggregated by app version. This resource requires authentication.
string
RequiredDetailed information about an app's distribution
1
2
3
4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution/version' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"series": [
{
"name": "<string>",
"elements": [
{
"date": "<string>",
"count": 63
}
]
}
]
}Get a list of app feedback matching the specified parameters. This resource requires authentication.
string
Requiredstring
boolean
string
integer
integer
A collection of feedback received for the app
1
2
3
4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/feedbacks' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"distributions": {
"template": "<string>",
"type": "<string>",
"name": "<string>"
},
"next": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"prev": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"feedbacks": [
{
"version": "<string>",
"time": "<string>",
"feedbackType": "disable",
"reasonCode": "bugs",
"message": "<string>",
"email": "<string>",
"fullName": "<string>",
"addonSen": "<string>"
}
]
}Get aggregated feedback for the specified app, aggregated by the specified metric. Feedback can be aggregated by type. This resource requires authentication.
string
Requiredstring
Requiredstring
string
Detailed information about an app's feedback distribution
1
2
3
4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/feedbacks/distribution?type={type}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"series": [
{
"name": "<string>",
"elements": [
{
"date": "<string>",
"count": 61
}
]
}
]
}Get pricing for the specified app. Live pricing is visible to all users. Pending pricing is only visible if you are authenticated as a vendor contact.
string
Requiredstring
Requiredstring
Required1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/pricing/{cloudOrServer}/{liveOrPending}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"items": [
{
"description": "<string>",
"editionId": "<string>",
"editionDescription": "<string>",
"editionType": "<string>",
"amount": 67,
"renewalAmount": 134,
"unitCount": 123,
"monthsValid": 70,
"licenseType": "<string>"
}
],
"perUnitItems": [
{
"description": "<string>",
"editionId": "<string>",
"editionDescription": "<string>",
"editionType": "<string>",
"amount": 67,
"renewalAmount": 134,
"unitCount": 123,
"monthsValid": 70,
"licenseType": "<string>"
}
],
"expertDiscountOptOut": true,
"contactSalesForAdditionalPricing": true,
"parent": "<string>",
"lastModified": "<string>",
"status": "live",
"default": true,
"hasPublishedPrices": true,
"canChangePrices": true,
"role": {
"singularName": "<string>",
"pluralName": "<string>"
}
}Update pricing for the specified app.
Updated pricing is always initially in the "pending" state.
For an app pending approval, pricing changes will go "live" when the app is approved. For an already-approved app, pricing changes will go "live" after 24 hours.
This resource requires authentication.
string
Requiredstring
Requiredstring
RequiredSelfLinkOnly
array<PricingItem>
Requiredarray<PricingItem>
boolean
RequiredAddonRole
Deprecated1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
curl --request PUT \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/pricing/{cloudOrServer}/{liveOrPending}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"items": [
{
"amount": 67,
"unitCount": 123,
"monthsValid": 70,
"licenseType": "<string>"
}
],
"perUnitItems": [
{
"amount": 67,
"unitCount": 123,
"monthsValid": 70,
"licenseType": "<string>"
}
],
"expertDiscountOptOut": true,
"role": {
"singularName": "<string>",
"pluralName": "<string>"
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"items": [
{
"description": "<string>",
"editionId": "<string>",
"editionDescription": "<string>",
"editionType": "<string>",
"amount": 67,
"renewalAmount": 134,
"unitCount": 123,
"monthsValid": 70,
"licenseType": "<string>"
}
],
"perUnitItems": [
{
"description": "<string>",
"editionId": "<string>",
"editionDescription": "<string>",
"editionType": "<string>",
"amount": 67,
"renewalAmount": 134,
"unitCount": 123,
"monthsValid": 70,
"licenseType": "<string>"
}
],
"expertDiscountOptOut": true,
"contactSalesForAdditionalPricing": true,
"parent": "<string>",
"lastModified": "<string>",
"status": "live",
"default": true,
"hasPublishedPrices": true,
"canChangePrices": true,
"role": {
"singularName": "<string>",
"pluralName": "<string>"
}
}Get apps recommended to users of the specified app.
string
Requiredstring
integer
array<string>
string
string
boolean
array<string>
string
boolean
array<string>
1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/recommendations' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"alternate": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"prev": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"next": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"_embedded": {
"addons": [
{
"_links": {
"self": {
"href": "<string>"
},
"alternate": {
"href": "<string>"
},
"vendor": {
"href": "<string>"
}
},
"_embedded": {},
"key": "<string>",
"name": "<string>",
"lastModified": "<string>"
}
]
},
"count": 45
}Get a specific app's release status. This resource requires authentication.
string
Required1
2
3
4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/release' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
{
"released": true
}Release an app after it has been approved.
If a vendor requests that their app is not automatically released after it has been approved, they can use this resource to release their app.
Set the released field to true. This only works one-way; vendors cannot set it to false later.
This resource requires authentication.
string
Requiredboolean
RequiredInvalid properties
1
2
3
4
5
6
7
curl --request PUT \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/release' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json' \
--data '{
"released": true
}'1
2
3
4
5
6
7
8
9
{
"errors": [
{
"message": "<string>",
"path": "<string>",
"code": "<string>"
}
]
}Get a list of access tokens for the specified app. In addition to vendor contacts, anonymous users can access this resource if they provide an existing valid token.
string
Required1
2
3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"descriptor": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"byToken": {
"template": "<string>",
"type": "<string>",
"name": "<string>"
}
},
"_embedded": {
"tokens": [
{
"_links": {
"self": {
"href": "<string>"
},
"descriptor": [
{
"href": "<string>"
}
]
},
"token": "<string>",
"instance": "<string>"
}
]
}
}Create a new access token. This resource requires authentication.
string
Required1
2
3
4
curl --request POST \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"descriptor": [
{
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
]
},
"token": "<string>",
"instance": "<string>"
}Get a specific access token. This resource requires authentication.
string
Requiredstring
Required1
2
3
4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens/{token}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"descriptor": [
{
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
]
},
"token": "<string>",
"instance": "<string>"
}Validates or associates an access token with a host.
For a new access token, this resource associates the token with a host. For tokens already associated with a host, this resource validates that the Origin header matches the associated host. The host is specified by the request's Origin header.
string
Requiredstring
RequiredSuccess
1
2
curl --request POST \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens/{token}'Delete a specific access token. This resource requires authentication.
string
Requiredstring
Required1
2
3
4
curl --request DELETE \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens/{token}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"descriptor": [
{
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
]
},
"token": "<string>",
"instance": "<string>"
}Returns whether or not the current user is watching the specified app. This resource requires authentication.
string
Required1
2
3
4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/watch' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"up": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"state": true
}Updates whether or not the current user is watching the specified app. This resource requires authentication.
string
RequiredBooleanStateRepLinks
boolean
RequiredSuccessfully modified
string
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl --request PUT \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/watch' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json' \
--data '{
"_links": {
"self": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"up": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"state": true
}'Rate this page: