Status Page Components
API endpoints for status page components
Manage status page components.
Components are organisation-scoped and can appear on multiple status pages via
each page’s structure. Use these endpoints to create and maintain components;
use status page structure endpoints to place them on pages.
The status page component object
A status page component that can appear on one or more status pages.
Components are organisation-scoped. Placement on a page is controlled by that page's structure, not by ownership of the component.
Unique identifier for this component
Example:
"01FCNDV6P870EA6S7TK1DSYDG1"
Show child attributes
Show child attributes
Example:
{
"annotations": { "incident.io/terraform/version": "3.0.0" },
"managed_by": "dashboard",
"source_url": "https://github.com/my-company/infrastructure"
}
Human-readable name for the component
Example:
"App"
Optional short description of this component
Example:
"Our iOS app"
Was this page helpful?
{
"id": "01FCNDV6P870EA6S7TK1DSYDG1",
"management_meta": {
"annotations": {
"incident.io/terraform/version": "3.0.0"
},
"managed_by": "dashboard",
"source_url": "https://github.com/my-company/infrastructure"
},
"name": "App",
"description": "Our iOS app"
}