API Reference · Status pages · Components
Create component
Mutation
createStatuspageComponentAdds a component to a status page, after the existing ones. A service can appear only once per page.
createStatuspageComponent(
organizationUUID: ID!
statuspageId: Int!
componentSpec: StatuspageComponentSpec!
): StatuspageComponent!Arguments
Field
Type
Returns
Field
Type
Example
mutation CreateStatuspageComponent($organizationUUID: ID!, $statuspageId: Int!, $componentSpec: StatuspageComponentSpec!) {
createStatuspageComponent(organizationUUID: $organizationUUID, statuspageId: $statuspageId, componentSpec: $componentSpec) {
id
position
type
description
createdAt
updatedAt
component {
__typename
... on StatuspageComponentPayloadService {
service {
id
name
description
}
}
}
health {
name
color
icon
}
}
}Example response
{
"data": {
"createStatuspageComponent": {
"id": "01JB3X7T9QK2M4N6P8R0S2T4V6",
"position": 1,
"type": "SERVICE",
"description": "Example description",
"createdAt": "2026-01-01T12:00:00Z",
"updatedAt": "2026-01-01T12:00:00Z",
"component": {
"__typename": "StatuspageComponentPayloadService",
"service": {
"id": 1,
"name": "Example name",
"description": "Example description"
}
},
"health": {
"name": "Example name",
"color": "#666bff",
"icon": "Example icon"
}
}
}
}