Compass
Guides
Reference
Changelog
Search
Support
Log in
Overview
About Compass
Getting started
Set up a Compass site
Understand user roles in Compass
Get started using Compass
Components
What is a component?
Search the component catalog
Create, view, update, and delete components
Create components using the API
Import components from other apps
Create and update components using a CSV file
Import components from Bitbucket
Import components from GitHub
Import components from GitLab
Import components from repositories linked to Jira
Import components from Jira Service Management
Add or remove component details
Set component tiers
Assign and update a component’s owner
Show on-call information from incident management tools on a component
What is the attention board?
Make and receive announcements
View a component's activity
What is an activity feed?
Get events from connected event sources
Send events using REST API
View a component's activity feed
Get data from your toolchain using incoming webhooks
Create incoming webhooks
Use existing incoming webhooks
Configure incoming webhooks
Delete incoming webhooks
Add or remove component dependencies
Link Jira issues to components
Synchronize components with Jira Service Management
Create, view, edit, and delete custom fields
Create, connect, and view component metrics
What are metrics
Create, edit, and delete metrics
Connect, view, and disconnect component metrics
What are derived metrics
Push metrics values using a cURL command
Get metrics from integrated tools
Available predefined metrics
Pin metrics to the top of metrics lists
Manage API documentation in Compass
What is the API feature?
Watch a component
Configuration as code
What is config as code?
Structure and contents of the compass.yml file
Manage components with config as code
Update components managed with config as code
Disconnect managed components from config as code
Templates
About templates
Create a template
Use a template
Teams
What is a team in Compass?
Start or search for a team
View a team's dashboard
What is the developer experience dashboard?
What is CheckOps?
Start CheckOps with your team
View past CheckOps information
What does health mean for you and your teams in Compass?
View your component's health details
Scorecards
What is a scorecard?
What is component readiness?
Create, view, update, and delete scorecards
Apply or remove scorecards
View and update a component's score
Use metrics with scorecards
What are metric thresholds?
How do scorecards use metrics?
Add a metric as a scorecard criterion
Use custom fields with scorecards
View scorecard health data
Create Jira issues for Compass scorecards
Integrations
Integrate Compass with Bitbucket Cloud
Integrate Compass with CircleCI
Integrate Compass with GitHub
Integrate Compass with GitLab
Integrate Compass with New Relic
Integrate Compass with Opsgenie
Integrate Compass with PagerDuty
Integrate Compass with Sentry
Integrate Compass with Slack
Integrate Compass with Snyk
Integrate Compass with Statuspage
Integrate Compass with Swagger UI
Administration
Change product plan
Manage users and their Compass access
Developer and API guides
Get started building Compass apps
Create a data provider app for events and metrics
GraphQL API toolkit
Use the API toolkit
API reference guide
API error guide
API requests examples
InvocationStatusCode
Property Name
Default value
Description
BAD_REQUEST
400
FORBIDDEN
403
INTERNAL_SERVER_ERROR
500
NOT_FOUND
404
OK
200
REQUEST_TIMEOUT
408
TOO_MANY_REQUESTS
429
UNAUTHORIZED
401
Rate this page:
Unusable
Poor
Okay
Good
Excellent