Rate this page:

Apps

Information about apps

Get apps

GET /rest/2/addons

Get a list of apps matching the specified parameters.

Request

Query parameters
application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

Format: int64
category

Array<string>

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values: free, marketplace, orderable, paid

filter

string

Return apps filtered or sorted using the specified parameter

Valid values: atlassian, codegeist, featured, highest-rated, name, new, popular, recent, top-grossing, top-vendor ...(Show more)

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

Array<string>

Only returns apps with the specified hosting model

Valid values: any, cloud, datacenter, server

includeHidden

string

Includes apps that are normally hidden in the site

Valid values: all, visibleInApp

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

marketingLabel

Array<string>

Only returns apps with the specified marketing labels

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

offset

integer

If specified, skips ahead by this number of items

Format: int32
limit

integer

If specified, limits the result set to this number of items

Format: int32

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

AddonCollection

Create app

POST /rest/2/addons

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.

Request

Body parameters
_links Required

AddonLinks

_embedded

AddonEmbedded

name Required

string

The display name of the app, for example "Questions for Confluence"

key Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

status Required

string

Indicates whether the app is public, private, or pending approval

Valid values: private, public, readytolaunch, rejected, submitted

summary

string

Summary of the app's functionality

tagLine

string

Short phrase that summarizes what the app does and will be displayed as a heading on the app details page

vendorLinks

AddonExternalLinks

enableAtlassianAnswers

boolean

This field is deprecated and will always be empty. If specified in a request body, it'll be ignored'

googleAnalyticsId

string

Google Analytics account ID for tracking visitors to the app page

legacy

AddonLegacyProperties

marketing

AddonMarketingProperties

statusAfterApproval

string

The status the app will transition to after it has been approved. If not specified, this will be Public

Valid values: private, public, readytolaunch, rejected, submitted

communityEnabled

boolean

To enable and disable showing the Atlassian Comunity Link for a supported app

jsdEmbeddedDataKey

string

The data key that associates the Jira Service Desk Widget with a specific Jira Service Desk project

dataCenterReviewIssueKey

string

Data Center apps go through a technical review process. This is the related issue key.

Example

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
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": {}
    }
  },
  "name": "<string>",
  "key": "<string>",
  "status": "private",
  "summary": "<string>",
  "tagLine": "<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>"
}'

Responses

Successfully created

A schema has not been defined for this response code.

Header Parameters
Location

string

URI of the new resource

Get archived apps

GET /rest/2/addons/archived

Get a list of archived apps matching the specified parameters.

Request

Query parameters
application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

Format: int64
category

Array<string>

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values: free, marketplace, orderable, paid

filter

string

Return apps filtered or sorted using the specified parameter

Valid values: atlassian, codegeist, featured, highest-rated, name, new, popular, recent, top-grossing, top-vendor ...(Show more)

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

Array<string>

Only returns apps with the specified hosting model

Valid values: any, cloud, datacenter, server

includeHidden

string

Includes apps that are normally hidden in the site

Valid values: all, visibleInApp

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

marketingLabel

Array<string>

Only returns apps with the specified marketing labels

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

offset

integer

If specified, skips ahead by this number of items

Format: int32
limit

integer

If specified, limits the result set to this number of items

Format: int32

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/archived' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

AddonListingCollection

Get archived apps (by vendor)

GET /rest/2/addons/archived/vendor/{vendorId}

Get a list of archived apps by a specific vendor matching the specified parameters.

Request

Path parameters
vendorId Required

integer

The unique identifier for this vendor

Format: int64
Query parameters
application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

Format: int64
category

Array<string>

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values: free, marketplace, orderable, paid

filter

string

Return apps filtered or sorted using the specified parameter

Valid values: atlassian, codegeist, featured, highest-rated, name, new, popular, recent, top-grossing, top-vendor ...(Show more)

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

Array<string>

Only returns apps with the specified hosting model

Valid values: any, cloud, datacenter, server

includeHidden

string

Includes apps that are normally hidden in the site

Valid values: all, visibleInApp

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

marketingLabel

Array<string>

Only returns apps with the specified marketing labels

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

offset

integer

If specified, skips ahead by this number of items

Format: int32
limit

integer

If specified, limits the result set to this number of items

Format: int32

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/archived/vendor/{vendorId}' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

AddonListingCollection

Get app banners

GET /rest/2/addons/listings/banners

Get a list of app banners matching the specified parameters.

Request

Query parameters
application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

Format: int64
category

Array<string>

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values: free, marketplace, orderable, paid

filter

string

Return apps filtered or sorted using the specified parameter

Valid values: atlassian, codegeist, featured, highest-rated, name, new, popular, recent, top-grossing, top-vendor ...(Show more)

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

Array<string>

Only returns apps with the specified hosting model

Valid values: any, cloud, datacenter, server

includeHidden

string

Includes apps that are normally hidden in the site

Valid values: all, visibleInApp

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

marketingLabel

Array<string>

Only returns apps with the specified marketing labels

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

offset

integer

If specified, skips ahead by this number of items

Format: int32
limit

integer

If specified, limits the result set to this number of items

Format: int32

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/listings/banners' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

AddonListingCollection

Get apps (brief)

GET /rest/2/addons/search/brief

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.

Request

Query parameters
q

string

Text to search for

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/search/brief' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

BriefSearchResult

Get apps (by vendor)

GET /rest/2/addons/vendor/{vendorId}

Get a list of apps for the specified vendor.

Request

Path parameters
vendorId Required

integer

The unique identifier for this vendor

Format: int64
Query parameters
application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

Format: int64
category

Array<string>

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values: free, marketplace, orderable, paid

filter

string

Return apps filtered or sorted using the specified parameter

Valid values: atlassian, codegeist, featured, highest-rated, name, new, popular, recent, top-grossing, top-vendor ...(Show more)

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

Array<string>

Only returns apps with the specified hosting model

Valid values: any, cloud, datacenter, server

includeHidden

string

Includes apps that are normally hidden in the site

Valid values: all, visibleInApp

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

marketingLabel

Array<string>

Only returns apps with the specified marketing labels

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

offset

integer

If specified, skips ahead by this number of items

Format: int32
limit

integer

If specified, limits the result set to this number of items

Format: int32

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/vendor/{vendorId}' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

AddonCollection

Get app

GET /rest/2/addons/{addonKey}

Get a specific app.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Query parameters
application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

Format: int64
category

Array<string>

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values: free, marketplace, orderable, paid

filter

string

Return apps filtered or sorted using the specified parameter

Valid values: atlassian, codegeist, featured, highest-rated, name, new, popular, recent, top-grossing, top-vendor ...(Show more)

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

Array<string>

Only returns apps with the specified hosting model

Valid values: any, cloud, datacenter, server

includeHidden

string

Includes apps that are normally hidden in the site

Valid values: all, visibleInApp

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

marketingLabel

Array<string>

Only returns apps with the specified marketing labels

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

Addon

Update app

PATCH /rest/2/addons/{addonKey}

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.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Body parameters
Content typeValue
application/json-patch+json

Array<JsonPatchDocumentation>

Example

1
2
3
curl --request PATCH \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}' \
  --user 'email@example.com:<api_token>'

Responses

Successfully modified

Header Parameters
Location

string

URI of the resource

Get app approval

GET /rest/2/addons/{addonKey}/approval

Get a specific app approval status. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

1
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'

Responses

Content typeValue
application/json

ApprovalStatus

Update app approval

PUT /rest/2/addons/{addonKey}/approval

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.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Body parameters
_links

ApprovalStatusLinks

status Required

string

Indicates the status of the approval

Valid values: approved, pending, rejected

reason

string

The reason why the app or app version was rejected

Format: html

Example

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

Responses

Invalid properties

Content typeValue
application/json

JsonErrorsDoc

Get app metrics

GET /rest/2/addons/{addonKey}/distribution

Get a summary of an app's latest metrics.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/distribution' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

AddonDistributionSummary

Get app active installations

GET /rest/2/addons/{addonKey}/distribution/active

Get a specific app's active installation counts over time. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

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'

Responses

Content typeValue
application/json

AddonDistribution

Get app active installations (by application)

GET /rest/2/addons/{addonKey}/distribution/application

Get a specific app's active installation counts over time, aggregated by application. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

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'

Responses

Content typeValue
application/json

AddonDistribution

Get app active installations (by application version)

GET /rest/2/addons/{addonKey}/distribution/application/version

Get a specific app's active installation counts over time, aggregated by application version. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

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'

Responses

Content typeValue
application/json

AddonDistribution

Get app active installations (by major application version)

GET /rest/2/addons/{addonKey}/distribution/application/version/major

Get a specific app's active installation counts over time, aggregated by major application version. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

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'

Responses

Content typeValue
application/json

AddonDistribution

Get app active installations (by minor application version)

GET /rest/2/addons/{addonKey}/distribution/application/version/minor

Get a specific app's active installation counts over time, aggregated by minor application version. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

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'

Responses

Content typeValue
application/json

AddonDistribution

Get app active installations (by app version)

GET /rest/2/addons/{addonKey}/distribution/version

Get a specific app's active installation counts over time, aggregated by app version. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

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'

Responses

Content typeValue
application/json

AddonDistribution

Get app feedback

GET /rest/2/addons/{addonKey}/feedbacks

Get a list of app feedback matching the specified parameters. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Query parameters
type

string

Return feedback for the specified feedback type only

Valid values: disable, uninstall

includeAnonymous

boolean

Include anonymous feedback

reason

string

Return feedback for the specified reason only

Valid values: bugs, cost, functionality, interface, other, reenabling, reinstalling, usefulness

offset

integer

If specified, skips ahead by this number of items

Format: int32
limit

integer

If specified, limits the result set to this number of items

Format: int32

Example

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'

Responses

Content typeValue
application/json

AddonFeedbackCollection

Get aggregated app feedback

GET /rest/2/addons/{addonKey}/feedbacks/distribution

Get aggregated feedback for the specified app, aggregated by the specified metric. Feedback can be aggregated by type. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Query parameters
type Required

string

Restricts the feedback distribution to the specified feedback type

Valid values: disable, uninstall

startDate

string

Starting date for the query

Format: date
endDate

string

Ending date for the query

Format: date

Example

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'

Responses

Content typeValue
application/json

AddonFeedbackDistribution

Get app pricing

GET /rest/2/addons/{addonKey}/pricing/{cloudOrServer}/{liveOrPending}

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.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

cloudOrServer Required

string

Valid values: cloud, datacenter, server

liveOrPending Required

string

Specifies either the pricing that is currently in effect and visible to users (live), or pending that will take effect after a delay

Valid values: live, pending

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/pricing/{cloudOrServer}/{liveOrPending}' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

Pricing

Submit app pricing

PUT /rest/2/addons/{addonKey}/pricing/{cloudOrServer}/{liveOrPending}

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.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

cloudOrServer Required

string

Valid values: cloud, datacenter, server

liveOrPending Required

string

Specifies either the pricing that is currently in effect and visible to users (live), or pending that will take effect after a delay

Valid values: live, pending

Body parameters
_links

SelfLinkOnly

items Required

Array<PricingItem>

The non-free pricing tiers for the app

perUnitItems

Array<PricingItem>

The per-unit pricing brackets for the app

expertDiscountOptOut Required

boolean

True if Atlassian Solution Partners cannot purchase the app at a discount

role

AddonRole

Example

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

Responses

Content typeValue
application/json

Pricing

Get app recommendations

GET /rest/2/addons/{addonKey}/recommendations

Get apps recommended to users of the specified app.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Query parameters
application

string

Only returns apps compatible with this application

applicationBuild

integer

Only returns apps compatible with the specified application build number

Format: int64
category

Array<string>

Only returns apps with any of the specified categories

cost

string

Only returns apps with the specified payment model

Valid values: free, marketplace, orderable, paid

filter

string

Return apps filtered or sorted using the specified parameter

Valid values: atlassian, codegeist, featured, highest-rated, name, new, popular, recent, top-grossing, top-vendor ...(Show more)

forThisUser

boolean

Only returns apps from vendors associated with the current user

hosting

Array<string>

Only returns apps with the specified hosting model

Valid values: any, cloud, datacenter, server

includeHidden

string

Includes apps that are normally hidden in the site

Valid values: all, visibleInApp

includePrivate

boolean

Includes private apps or versions if you are authorized to see them

marketingLabel

Array<string>

Only returns apps with the specified marketing labels

text

string

Only returns apps that match the search text

withVersion

boolean

Includes the latest compatible version in the response

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/recommendations' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

AddonListingCollection

Get app release status

GET /rest/2/addons/{addonKey}/release

Get a specific app's release status. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

1
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'

Responses

Content typeValue
application/json

AddonReleaseStatus

Release app

PUT /rest/2/addons/{addonKey}/release

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.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Body parameters
released Required

boolean

Whether the app has been released

Example

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
}'

Responses

Invalid properties

Content typeValue
application/json

JsonErrorsDoc

Get access tokens

GET /rest/2/addons/{addonKey}/tokens

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.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

1
2
3
curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

TokenCollection

Create access token

POST /rest/2/addons/{addonKey}/tokens

Create a new access token. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

1
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'

Responses

Content typeValue
application/json

Token

Get access token

GET /rest/2/addons/{addonKey}/tokens/{token}

Get a specific access token. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

token Required

string

Example

1
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'

Responses

Content typeValue
application/json

Token

Validate access token

POST /rest/2/addons/{addonKey}/tokens/{token}

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.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

token Required

string

Example

1
2
curl --request POST \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/tokens/{token}'

Responses

Success

Delete access token

DELETE /rest/2/addons/{addonKey}/tokens/{token}

Delete a specific access token. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

token Required

string

Example

1
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'

Responses

Content typeValue
application/json

Token

Get watch/unwatch app state

GET /rest/2/addons/{addonKey}/watch

Returns whether or not the current user is watching the specified app. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Example

1
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'

Responses

Content typeValue
application/json

BooleanState

Watch / unwatch app

PUT /rest/2/addons/{addonKey}/watch

Updates whether or not the current user is watching the specified app. This resource requires authentication.

Request

Path parameters
addonKey Required

string

The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"

Body parameters
_links

BooleanStateRepLinks

state Required

boolean

The true/false value of the state - its meaning depends on the resource

Example

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
}'

Responses

Successfully modified

Header Parameters
Location

string

URI of the resource

Rate this page: