{ "info": { "_postman_id": "e825ff2b-b423-46f7-814a-d552ae998be7", "name": "Compass REST API", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "Metrics", "description": "This resource represents metrics. Use this resource to send metric values into a component's metric source.", "item": [ { "name": "Send metric value", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}compass/v1/metrics", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Sends a metric value into a metric source for a [component](/cloud/compass/components/what-is-a-component/). This API is rate limited. Only 100 requests per user per minute are allowed.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Events", "description": "This resource represents events. Use this resource to send events into an event source.", "item": [ { "name": "Send event", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}compass/v1/events", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Sends an event into an event source. This API is rate limited. Only 100 requests per user per minute are allowed.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Other operations", "item": [ { "name": "Get Forge App attachment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}compass/v1/component/:componentId/app/:forgeAppId/attachment/:key", "query": [], "variable": [ { "key": "componentId", "value": "{{componentId}}", "disabled": false }, { "key": "forgeAppId", "value": "{{forgeAppId}}", "disabled": false }, { "key": "key", "value": "{{key}}", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a file attached to a component. If you need to have attachment upload enabled for your Compass Forge app, contact Atlassian support.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Upload Forge App attachment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}compass/v1/component/:componentId/app/:forgeAppId/attachment/:key", "query": [], "variable": [ { "key": "componentId", "value": "{{componentId}}", "disabled": false }, { "key": "forgeAppId", "value": "{{forgeAppId}}", "disabled": false }, { "key": "key", "value": "{{key}}", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Attach a file to a component. If you need to have attachment upload enabled for your Compass Forge app, contact Atlassian support.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete Forge App attachment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}compass/v1/component/:componentId/app/:forgeAppId/attachment/:key", "query": [], "variable": [ { "key": "componentId", "value": "{{componentId}}", "disabled": false }, { "key": "forgeAppId", "value": "{{forgeAppId}}", "disabled": false }, { "key": "key", "value": "{{key}}", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete file attached to a component. If you need to have attachment upload enabled for your Compass Forge app, contact Atlassian support.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "An invocation of an inbound webhook", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}compass/v1/webhooks/:webhookId", "query": [], "variable": [ { "key": "webhookId", "value": "{{webhookId}}", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Third parties can call these inbound webhooks to dothings within compass, like create deployment events for webhooks coming from github", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get Entitlement Results", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}compass/v1/entitlements", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get entitlement results for a given user and site", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] } ], "variable": [ { "key": "protocol", "name": "Protocol", "description": "The HTTP Protocol that should be used for this REST API.", "type": "string", "value": "https" }, { "key": "host", "name": "Host", "description": "The HTTP host that should be used for this REST API.", "type": "string", "value": "your-domain.atlassian.net" }, { "key": "basePath", "name": "Base Path", "description": "The path, after the host, of the base of the REST API.", "type": "string", "value": "gateway/api/" } ] }