The Compass REST API v1 provides operations for component management, scorecard configuration, and webhook registration via standard HTTP REST conventions with OAuth 2.0 authentication.
Atlassian Compass REST API is one of 4 APIs that Atlassian Compass publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Components, Developer Experience, REST, and Software Catalog. The published artifact set on APIs.io includes API documentation, authentication docs, an OpenAPI specification, and an API reference.
This API exposes
11 operations
across 8 paths,
organized into 6 resource areas,
and defines 38 schemas.
It is described by OpenAPI 3.1.0, at version 1.
Requests are made against a single base URL, https://your-domain.atlassian.net/gateway/api.
11 operations8 paths38 schemas3 DELETE1 GET4 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
1
Base URL
https://api.atlassian.com/compass/v1
Authentication
HTTP Basic
Resource Areas
6
Authentication & Security 1
Atlassian Compass REST API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
Paths & Operations 11
Across 8 paths, the API surfaces 11 operations — 3 DELETE, 1 GET, 4 POST, 3 PUT. They span 6 resource areas: Package Dependencies, attachment-rest-controller, incoming-webhooks-rest-controller, Metrics, Events, entitlement-rest-controller. Each is listed below with its method, path, parameters, and response codes.
Package Dependencies 2
This resource represents package dependencies. Use this resource to associate package dependencies with a component.
This resource represents metrics. Use this resource to send metric values into a component's metric source.
POST
/compass/v1/metrics
Send metric value
insertMetricValuebody→ 200400403404429
Events 1
This resource represents events. Use this resource to send events into an event source.
POST
/compass/v1/events
Send event
createCompassEventbody→ 202400404429
entitlement-rest-controller 1
POST
/compass/v1/entitlements
Get Entitlement Results
evaluateEntitlementsbody→ 200401
Schemas 38
The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are CompassEventInputDto (10 properties), CompassCreateVulnerabilityEventPropertiesInputDto (8 properties), CompassCreateAlertEventInputDto (7 properties), CompassCreateDeploymentEventInputDto (7 properties). Each schema is shown below with its type and property counts.
ErrorDto
object
An error.
2 properties
ErrorResponseDto
object
A list of errors that occurred.
1 property
Attachment
object
3 properties3 required
InsertMetricByMetricDefinitionRequestDto
3 required
InsertMetricByMetricSourceRequestDto
2 required
InsertMetricRequestDto
object
5 properties1 required
InsertMetricResponseDto
object
The metric value that was sent into the metric source.
4 properties3 required
CompassAlertEventPropertiesInputDto
object
The list of properties of the alert event.
7 properties1 required
CompassBuildEventPipelineInputDto
object
The build event pipeline.
3 properties1 required
CompassBuildEventPropertiesInputDto
object
The list of properties of the build event.
4 properties3 required
CompassCreateAlertEventInputDto
object
An alert event.
7 properties7 required
CompassCreateBuildEventInputDto
object
A build event.
7 properties7 required
CompassCreateCustomEventInputDto
object
A custom event.
7 properties7 required
CompassCreateDeploymentEventInputDto
object
A deployment event.
7 properties7 required
CompassCreateDeploymentEventPropertiesInputDto
object
The list of properties of the deployment event.
6 properties4 required
CompassCreateFlagEventInputDto
object
A flag event.
7 properties7 required
CompassCreateFlagEventPropertiesInputDto
object
The list of properties of the flag event.
2 properties1 required
CompassCreateIncidentEventInputDto
object
An incident event.
7 properties7 required
CompassCreateIncidentEventPropertiesInputDto
object
The list of properties of the incident event.
5 properties3 required
CompassCreateLifecycleEventInputDto
object
A lifecycle event.
7 properties7 required
CompassCreatePullRequestEventInputDto
object
A pull request event. Warning: This option is currently only usable by Forge apps and does not add events to the Activity Feed.
3 properties2 required
CompassCreatePushEventInputDto
object
A push event.
7 properties7 required
CompassCreateVulnerabilityEventInputDto
object
A vulnerability event.
7 properties7 required
CompassCreateVulnerabilityEventPropertiesInputDto
object
The list of properties of the vulnerability event.
8 properties4 required
CompassCustomEventPropertiesInputDto
object
The list of properties of the custom event.
2 properties2 required
CompassDeploymentEventEnvironmentInputDto
object
The environment where the deployment event has occurred.
3 properties3 required
CompassDeploymentEventPipelineInputDto
object
The deployment event pipeline.
3 properties3 required
CompassEventInputDto
object
The type of event. One and only one of the fields in this input type must be provided.
10 properties
CompassIncidentEventSeverityInputDto
object
The severity of an incident
2 properties
CompassLifecycleEventInputPropertiesDto
object
The list of properties of the lifecycle event.
2 properties2 required
CompassPullRequestInputPropertiesDto
object
The list of properties of the pull event.
4 properties4 required
CompassPushEventAuthorInputDto
object
The author who made the push
2 properties
CompassPushEventInputPropertiesDto
object
The list of properties of the push event.
3 properties2 required
CompassVulnerabilityEventSeverityInputDto
object
The severity of a vulnerability
2 properties1 required
CreateStreamlinedEventRequest
object
3 properties2 required
EntitlementRequestDto
object
1 property1 required
EntitlementResponseDto
object
1 property1 required
EntitlementResultDto
object
1 property1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Atlassian Compass REST API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
