Supercheck LogoSupercheck
Status Pages

Create a status page component

Add a component to a status page. Requires status_page:update. Unknown body fields are rejected with 400.

POST
/api/status-pages/{id}/components

Authorization

bearerAuth
headerAuthorizationBearer <token>

Project-scoped CLI token (sck_live_* or sck_test_*) for documented API operations that accept bearer authentication. Interactive browser operations may require a session cookie. Trigger keys (sck_trigger_* / legacy job_*) are accepted only by job trigger endpoints.

Path Parameters

id*string

Status page ID

Formatuuid

Request Body

application/json
  1. body
name*string
Length1 <= length <= 255
description?string
Lengthlength <= 2000
monitorIds?array<>

Monitors of the current project to link. Duplicates are collapsed. On update, replaces the whole set.

Itemsitems <= 100
status?string

Manual status. When omitted while monitors are linked, the status is derived from the monitors.

Default"operational"
Value in"operational""degraded_performance""partial_outage""major_outage""under_maintenance"
showcase?boolean

Show the component on the public page.

Defaulttrue
onlyShowIfDegraded?boolean
Defaultfalse
position?integer
Range0 <= value <= 1000
Default0
aggregationMethod?string
Default"worst_case"
Value in"worst_case""best_case""weighted_average""majority_vote"
autoCreateIncidents?boolean
serviceId?string

AI SRE service in the current project.

Formatuuid
monitorWeights?

Weight per monitor ID (max 100 entries); default weight is 1.

failureThreshold?integer
Range1 <= value <= 100
Default1

Response Body

Created component

application/json
  1. response
component?
Example Request
curl -X POST 'https://demo.supercheck.dev/api/status-pages/497f6eca-6276-4993-bfeb-53cbbbba6f08/components' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
{  "component": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "position": 0,    "monitorIds": [      "b097df87-5e66-49a7-b709-53c1c4c15b17"    ],    "status": "operational",    "showcase": true,    "onlyShowIfDegraded": true,    "aggregationMethod": "worst_case",    "failureThreshold": 0,    "autoCreateIncidents": true,    "serviceId": "8f8bb40f-b96b-40fe-9064-5031fbe483f9"  }}

List status page components GET

Previous Page

Update a status page component PUT

Next Page