• Metrics
  • Events
  • Other operations
Cloud
Compass / Reference / REST API

Rate this page:

Other operations

Postman Collection
OpenAPI
GET

Get Forge App attachment

Get a file attached to a component

Request

Path parameters

componentId

string

Required
forgeAppId

string

Required
key

string

Required

Responses

Returned if the file exists.

application/json

Attachment
GET/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}
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'
200Response
1 2 3 4 5 { "name": "<string>", "url": "<string>", "lastModifiedAt": "<string>" }
PUT

Upload Forge App attachment

Upload a file to be attached to a component

Request

Path parameters

componentId

string

Required
forgeAppId

string

Required
key

string

Required

Request bodymultipart/form-data

file

string

Required

Responses

Returned if the file upload is successful.

application/json

Attachment
PUT/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}
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'
200Response
1 2 3 4 5 { "name": "<string>", "url": "<string>", "lastModifiedAt": "<string>" }
DEL

Delete Forge App attachment

Delete file attached to a component

Request

Path parameters

componentId

string

Required
forgeAppId

string

Required
key

string

Required

Responses

Returned if the file delete is successful.

DEL/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}
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>'
POST

Get Entitlement Results

Get entitlement results for a given user and site

Request

Request bodyapplication/json

entitlements

array<string>

Required

Responses

Returned if the file upload is successful.

application/json

EntitlementResponseDto
POST/compass/v1/entitlements
1 2 3 4 5 6 7 8 9 10 curl --request POST \ --url 'https://your-domain.atlassian.net/gateway/api/compass/v1/entitlements' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "entitlements": [ "<string>" ] }'
200Response
1 2 3 { "entitlements": {} }