Rate this page:
Information about app versions
GET /rest/2/addons/{addonKey}/versions
Get a list of versions for the specified app.
string
The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"
string
Selects only app versions newer than the version with the specified display name
string
Only returns apps compatible with this application
integer
Only returns apps compatible with the specified application build number
int64
string
Only returns apps with the specified payment model
Valid values: free
, marketplace
, orderable
, paid
string
Only returns apps with the specified hosting model
Valid values: any
, cloud
, datacenter
, server
boolean
Includes private apps or versions if you are authorized to see them
integer
If specified, skips ahead by this number of items
int32
integer
If specified, limits the result set to this number of items
int32
1 2 3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
POST /rest/2/addons/{addonKey}/versions
Create a new version for the specified app. This resource requires authentication.
string
The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"
integer
The unique internal identifier and sort key for this version; omit this if you are creating an Atlassian Connect version
int64
string
The display name of the version, for example "1.0.0"
string
Indicates whether the version is public, private, or pending approval
Valid values: private
, public
, rejected
, submitted
string
The payment model; you may omit this when creating a version and Marketplace will infer it, unless it is paid via vendor
Valid values: atlassian
, free
, vendor
string
YouTube video identifier if the version's hero image is a video
Array<Compatibility>
Describes the application(s), version ranges, and hosting models the app version is compatible with; you may omit this when creating a version and Marketplace will use the previous version's compatibilities
string
Integration type if the app is a Hipchat integration
Valid values: global
, informational
, room
Cloud app information, if the deployment type of the version is Atlassian cloud
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
curl --request POST \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions' \
--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>"
},
"agreement": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"artifact": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"edit": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"approval": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"transition": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"hero": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
},
"license": {
"href": "<string>",
"type": "<string>",
"title": "<string>"
}
},
"_embedded": {
"artifact": {
"_links": {
"self": {
"href": "<string>"
},
"binary": {
"href": "<string>"
}
}
},
"hero": {
"_links": {
"self": {
"href": "<string>"
},
"image": {
"href": "<string>"
},
"unscaled": {
"href": "<string>"
}
}
},
"highlights": [
{
"_links": {
"screenshot": {
"href": "<string>"
},
"thumbnail": {
"href": "<string>"
}
},
"_embedded": {
"screenshot": {
"_links": {
"self": {
"href": "<string>"
},
"image": {
"href": "<string>"
},
"unscaled": {
"href": "<string>"
}
}
},
"thumbnail": {
"_links": {
"self": {
"href": "<string>"
},
"image": {
"href": "<string>"
},
"unscaled": {
"href": "<string>"
}
}
}
},
"title": "<string>",
"body": "<string>",
"explanation": "<string>"
}
],
"screenshots": [
{
"_links": {
"image": {
"href": "<string>"
}
},
"_embedded": {
"image": {
"_links": {
"self": {
"href": "<string>"
},
"image": {
"href": "<string>"
},
"unscaled": {
"href": "<string>"
}
}
}
},
"caption": "<string>"
}
],
"instructions": [
{
"_links": {},
"_embedded": {},
"body": "<string>"
}
],
"license": {
"_links": {
"self": {
"href": "<string>"
}
},
"key": "<string>",
"name": "<string>"
}
},
"buildNumber": 120,
"name": "<string>",
"status": "private",
"paymentModel": "atlassian",
"release": {
"date": "<string>",
"releasedBy": "<string>",
"beta": true,
"supported": true
},
"youtubeId": "<string>",
"vendorLinks": {
"binary": "<string>",
"documentation": "<string>",
"license": "<string>",
"learnMore": "<string>",
"eula": "<string>",
"purchase": "<string>",
"releaseNotes": "<string>"
},
"compatibilities": [
{
"application": "<string>",
"hosting": {
"cloud": true,
"server": {
"min": {
"build": 117
},
"max": {
"build": 117
}
},
"dataCenter": {
"min": {
"build": 117
},
"max": {
"build": 117
}
}
}
}
],
"text": {
"releaseSummary": "<string>",
"moreDetails": "<string>",
"releaseNotes": "<string>"
},
"integrationType": "global",
"legacy": {
"vendorLinks": {
"releaseNotes": "<string>",
"javadocs": "<string>",
"source": "<string>",
"evaluationLicense": "<string>",
"donate": "<string>"
}
},
"deployment": {},
"cloud": {
"appId": "<string>",
"appEnvironmentId": "<string>",
"appVersionId": "<string>",
"appScopes": [
{
"_links": {
"alternate": {
"href": "<string>"
}
},
"key": "<string>",
"name": "<string>",
"description": "<string>"
}
]
}
}'
Successfully created
A schema has not been defined for this response code.
string
URI of the new resource
GET /rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}
Get the latest version of the specified app.
string
The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"
integer
The unique internal identifier and sort key for this version
int64
1 2 3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
PATCH /rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}
Update a specific version for the specified 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
The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"
integer
The unique internal identifier and sort key for this version
int64
Content type | Value |
---|---|
application/json-patch+json | Array<JsonPatchDocumentation> |
1 2 3
curl --request PATCH \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}' \
--user 'email@example.com:<api_token>'
Successfully modified
string
URI of the resource
GET /rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}/approval
Get a specific app version approval status. This resource requires authentication.
string
The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"
integer
The unique internal identifier and sort key for this version
int64
1 2 3 4
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}/approval' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
PUT /rest/2/addons/{addonKey}/versions/build/{pluginBuildNumber}/approval
Approve, reject or resubmit an app version for approval.
Vendors can use this resource to resubmit a previously rejected app version for approval. This is done by setting the status
field to pending
.
Administrators can use this resource to approve or reject an app version that is submitted for approval.
This resource requires authentication.
string
The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"
integer
The unique internal identifier and sort key for this version
int64
string
Indicates the status of the approval
Valid values: approved
, pending
, rejected
string
The reason why the app or app version was rejected
html
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}/versions/build/{pluginBuildNumber}/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>"
}'
Success
GET /rest/2/addons/{addonKey}/versions/latest
Get the latest version of the specified app.
string
The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"
string
Selects only app versions newer than the version with the specified display name
string
Only returns apps compatible with this application
integer
Only returns apps compatible with the specified application build number
int64
string
Only returns apps with the specified payment model
Valid values: free
, marketplace
, orderable
, paid
string
Only returns apps with the specified hosting model
Valid values: any
, cloud
, datacenter
, server
boolean
Includes private apps or versions if you are authorized to see them
1 2 3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions/latest' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
GET /rest/2/addons/{addonKey}/versions/name/{name}
Get details about a specific version, matching the specified name, of the specified app.
string
The unique identifier for this app, for example "com.atlassian.confluence.plugins.confluence-questions"
string
The display name of the version, for example "1.0.0"
string
Only returns apps with the specified hosting model
Valid values: any
, cloud
, datacenter
, server
1 2 3
curl --request GET \
--url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/versions/name/{name}' \
--header 'Accept: application/json'
Content type | Value |
---|---|
application/json |
Rate this page: