Get a file attached to a component. If you need to have attachment upload enabled for your Compass Forge app, contact Atlassian support.
string
Requiredstring
Requiredstring
RequiredReturned if the file exists.
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'1
2
3
4
5
{
"name": "<string>",
"url": "<string>",
"lastModifiedAt": "<string>"
}Attach a file to a component. If you need to have attachment upload enabled for your Compass Forge app, contact Atlassian support.
The request body should be a file.
Example: This curl command attaches a file to a component.
1 2 3 4 5curl --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 'Content-Type: multipart/form-data' \ --form file=@/path/to/attachment.txt
string
Requiredstring
Requiredstring
Requiredstring
RequiredReturned if the file upload is successful.
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'1
2
3
4
5
{
"name": "<string>",
"url": "<string>",
"lastModifiedAt": "<string>"
}Delete file attached to a component. If you need to have attachment upload enabled for your Compass Forge app, contact Atlassian support.
string
Requiredstring
Requiredstring
RequiredReturned if the file delete is successful.
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>'Upload api specs for a component.
The request body should be a file with the api-spec content.
Example: This curl command uploads a spec file (swagger.yaml) for the component.
1 2 3 4 5curl --request PUT \ --url 'https://your-domain.atlassian.net/gateway/api/compass/v1/component/{componentId}/api_specs' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: multipart/form-data' \ --form file=@/path/to/file/swagger.yaml
string
Requiredstring
RequiredReturned if the file upload is successful.
string
1
2
3
4
curl --request PUT \
--url 'https://your-domain.atlassian.net/gateway/api/compass/v1/component/{componentId}/api_specs' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
"<string>"Third parties can call these inbound webhooks to dothings within compass, like create deployment events for webhooks coming from github
string
Requiredstring
Returned if the process of invoking a webhook with a payload has been enqueud.
1
2
3
4
5
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>"'Get entitlement results for a given user and site
array<string>
RequiredReturned if the file upload is successful.
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>"
]
}'1
2
3
{
"entitlements": {}
}Rate this page: