v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBStatus Pages
Create component
Creates a new component.
post/api/v2/statuspages/{page_id}/components
Path parameters
page_idstring uuid required
Example:1234abcd-12ab-34cd-56ef-123456abcdef
The ID of the status page.
Query parameters
includestring
Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group.
Request body
Example request
{
"data": {
"attributes": {
"name": "Metrics Intake",
"position": 0,
"type": "component"
},
"relationships": {
"group": {
"data": null
}
},
"type": "components"
}
}Response
Created
Example response
{
"data": {
"attributes": {
"components": [
{
"type": "component"
}
],
"status": "operational",
"type": "component"
},
"relationships": {
"created_by_user": {
"data": {
"type": "users"
}
},
"group": {
"data": {
"id": "1234abcd-12ab-34cd-56ef-123456abcdef",
"type": "components"
}
},
"last_modified_by_user": {
"data": {
"type": "users"
}
},
"status_page": {
"data": {
"id": "1234abcd-12ab-34cd-56ef-123456abcdef",
"type": "status_pages"
}
}
},
"type": "components"
},
"included": [
{
"type": "users"
}
]
}