Rate this page:

Assets

For uploading app/image files

Get asset links

GET /rest/2/assets

Get links to permitted asset resources.

Request

There are no parameters for this request.

Example

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

Responses

Content typeValue
application/json

HasAssetsCollectionLinks

Upload app artifact

POST /rest/2/assets/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.

Request

Query parameters
file Required

string

The logical filename

Body parameters
Content typeValue
application/json

string

Example

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

Responses

Content typeValue
application/json

AddonArtifactAsset

Validate app artifact

POST /rest/2/assets/artifact/fetch

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 Required

string

Marketplace will attempt to download the artifact from this location

Format: uri

Example

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'

Responses

Content typeValue
application/json

AddonArtifactAsset

Upload image

POST /rest/2/assets/image/{imageType}

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 Required

string

Specifies what this image will be used for, which determines the allowable image size

Valid values: banner, hero, icon, logo, screenshot, screenshot-thumbnail, title-logo

Query parameters
file Required

string

The logical filename

Body parameters
Content typeValue
application/json

string

Example

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

Responses

Content typeValue
application/json

ImageAsset

Get asset details

GET /rest/2/assets/{assetName}

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 Required

string

The unique identifying string that Marketplace uses to refer to this asset

Example

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

Responses

Content typeValue
application/json

ImageAsset

Delete asset

DELETE /rest/2/assets/{assetName}

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 Required

string

The unique identifying string that Marketplace uses to refer to this asset

Example

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

Responses

Success

Rate this page: