• App versions
  • Applications
  • Apps
  • Assets
  • Categories
  • License types
  • Migrations
  • Privacy and Security
  • Products
  • Promotions (Removed)
  • Reporting
  • Reviews
  • Vendors
Platform
Atlassian Marketplace / Reference / Marketplace REST API (v2)

Assets

Postman Collection
OpenAPI
GET

Get asset links

Get links to permitted asset resources.

Request

This request has no parameters.

Responses

application/json

HasAssetsCollectionLinks
GET/assets
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/assets' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "artifact": { "href": "<string>", "type": "<string>", "title": "<string>" }, "fetchArtifact": { "href": "<string>", "type": "<string>", "title": "<string>" }, "imageByType": { "template": "<string>", "type": "<string>", "name": "<string>" } } }
POST

Upload app artifact

Use this resource to upload an app artifact (.jar or .obr) to Marketplace, so it can be used by an app version.

The request body is the file data.

If successful, the resource will respond with a resource link in _links.self that can be used as the artifact link when creating an app or app version. The response may include additional properties; other than fileInfo, these are used internally and should be ignored.

This resource requires authentication.

Example: This curl command uploads the artifact present in a file ('my-file.jar').

1 2 3 4 5 6 curl --request POST \ --url https://marketplace.atlassian.com/rest/2/assets/artifact \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: multipart/form-data' \ --form file=@"my-file.jar"

Request

Request bodymultipart/form-data

file

string

Required

Responses

application/json

AddonArtifactAsset
POST/assets/artifact
1 2 3 4 curl --request POST \ --url 'https://marketplace.atlassian.com/rest/2/assets/artifact' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "binary": { "href": "<string>", "type": "<string>", "title": "<string>" }, "remote": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "fileInfo": { "logicalFileName": "<string>", "size": 22 } }
POST

Validate app artifact

Use this resource to copy and validate an app artifact (.jar or .obr) that is available from an external URL, so it can be used by an app version.

If successful, you will get a resource link in _links.self that can be used as the artifact link when creating an app or app version.

Note that this step can be skipped by just setting the artifact link to the external URL where the artifact is hosted when creating an app version; Marketplace will then download the artifact automatically.

This resource requires authentication.

Request

Query parameters

uri

string

Required

Responses

application/json

AddonArtifactAsset
POST/assets/artifact/fetch
1 2 3 4 curl --request POST \ --url 'https://marketplace.atlassian.com/rest/2/assets/artifact/fetch?uri={uri}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "binary": { "href": "<string>", "type": "<string>", "title": "<string>" }, "remote": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "fileInfo": { "logicalFileName": "<string>", "size": 22 } }
POST

Upload image

Use this resource to upload an image (.jpg, .png, .gif, .bmp) to Marketplace, so you can use it for an app or vendor.

The request body is the file data.

If successful, you will get a resource link in _links.self that you can use as the appropriate image link in another resource, for example the logo link if you are creating an app.

Note that if the image is available from an external URL, you can skip this step by just setting the image link tothat external URL when you are creating the resource that uses it.

Request

Path parameters

imageType

string

Required

Query parameters

file

string

Required

Request bodyapplication/json

binaryData

Responses

application/json

ImageAsset
POST/assets/image/{imageType}
1 2 3 4 5 curl --request POST \ --url 'https://marketplace.atlassian.com/rest/2/assets/image/{imageType}?file={file}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '"<string>"'
200Response
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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "image": { "href": "<string>", "type": "<string>", "title": "<string>" }, "unscaled": { "href": "<string>", "type": "<string>", "title": "<string>" }, "highRes": { "href": "<string>", "type": "<string>", "title": "<string>" }, "smallImage": { "href": "<string>", "type": "<string>", "title": "<string>" }, "smallHighResImage": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "fileInfo": { "logicalFileName": "<string>", "size": 22 } }
GET

Get asset details

Returns details about a previously uploaded file that Marketplace is now storing. The asset can either be an image file or an app artifact. If it is an app artifact, the response may include additional properties which are used internally and should be ignored.

Request

Path parameters

assetName

string

Required

Responses

application/json

ImageAsset
GET/assets/{assetName}
1 2 3 curl --request GET \ --url 'https://marketplace.atlassian.com/rest/2/assets/{assetName}' \ --header 'Accept: application/json'
200Response
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 { "_links": { "self": { "href": "<string>", "type": "<string>", "title": "<string>" }, "image": { "href": "<string>", "type": "<string>", "title": "<string>" }, "unscaled": { "href": "<string>", "type": "<string>", "title": "<string>" }, "highRes": { "href": "<string>", "type": "<string>", "title": "<string>" }, "smallImage": { "href": "<string>", "type": "<string>", "title": "<string>" }, "smallHighResImage": { "href": "<string>", "type": "<string>", "title": "<string>" } }, "fileInfo": { "logicalFileName": "<string>", "size": 22 } }
DEL

Delete asset

Removes a file from Marketplace storage which had been previously uploaded.

This is only allowed if:

  1. you, rather than another user, uploaded the file, and
  2. the asset is not currently being used by any other resource (for example, it cannot be the logo image for an existing app).

This resource requires authentication.

Request

Path parameters

assetName

string

Required

Responses

Success

DEL/assets/{assetName}
1 2 3 curl --request DELETE \ --url 'https://marketplace.atlassian.com/rest/2/assets/{assetName}' \ --user 'email@example.com:<api_token>'

Rate this page: