Cloud

Compass / Reference / REST API

Other operations

Operations

GET/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}PUT/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}DEL/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}POST/compass/v1/webhooks/{webhookId}POST/compass/v1/entitlements

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}

curl

Node.js

Java

Python

PHP

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

{
  "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}

curl

Node.js

Java

Python

PHP

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

{
  "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}

curl

Node.js

Java

Python

PHP

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

An invocation of an inbound webhook

Third parties can call these inbound webhooks to dothings within compass, like create deployment events for webhooks coming from github

Request

Path parameters

webhookId

string

Required

Request bodyapplication/json

string

Responses

Returned if the process of invoking a webhook with a payload has been enqueud.

POST/compass/v1/webhooks/{webhookId}

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://your-domain.atlassian.net/gateway/api/compass/v1/webhooks/{webhookId}' \
  --user 'email@example.com:<api_token>' \
  --header 'Content-Type: application/json' \
  --data '"<string>"'

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

curl

Node.js

Java

Python

PHP

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": {}
}