Metrics
Events
Other operations

Rate this page:

Other operations

Get Forge App attachment

GET /gateway/api/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}

Get a file attached to a component

Request

Path parameters
componentId Required

string

Format: uuid
forgeAppId Required

string

key Required

string

Example

1
2
3
4
curl --request GET \
  --url 'https://your-domain.atlassian.net/gateway/api/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Returned if the file exists.

Content typeValue
application/json

Attachment

Upload Forge App attachment

PUT /gateway/api/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}

Upload a file to be attached to a component

Request

Path parameters
componentId Required

string

Format: uuid
forgeAppId Required

string

key Required

string

Body parameters
Content typeValue
multipart/form-data

object

Example

1
2
3
4
curl --request PUT \
  --url 'https://your-domain.atlassian.net/gateway/api/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

Responses

Returned if the file upload is successful.

Content typeValue
application/json

Attachment

Delete Forge App attachment

DELETE /gateway/api/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}

Delete file attached to a component

Request

Path parameters
componentId Required

string

Format: uuid
forgeAppId Required

string

key Required

string

Example

1
2
3
curl --request DELETE \
  --url 'https://your-domain.atlassian.net/gateway/api/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}' \
  --user 'email@example.com:<api_token>'

Responses

Returned if the file delete is successful.

A schema has not been defined for this response code.

Rate this page: