Accounts11

Alert channels6

Alert notifications1

Analytics12

Badges2

Check alerts2

Check groups11

Check results4

Check sessions7

Check status2

Checks15

Client certificates4

Dashboards5

Deployment Triggers2

Elements2

Environment variables5

Error Groups4

Heartbeats5

Incident Updates3

Incidents4

Location1

Maintenance windows12

Monitors14

Private locations8

Reporting1

Rocky AI3

Runtimes2

Secret scans1

Snippets5

Static IPs6

Status Page Incidents10

Status Page Services5

Status Pages8

Status Pages V37

Status Pages V3 Automation Rules5

Status Pages V3 Components5

Status Pages V3 Incidents11

Status Pages V3 Subscribers3

Test Session Error Groups4

Test sessions7

Triggers6

Usage8

Status Pages V3 Components

Update a component of a v3 status page.

Changed on Oct 31, 2026

Update a component. This is a full replacement: omitted optional fields are reset.

put/v3/status-pages/{statusPageId}/components/{componentId}

Request

Base URL
https://api.checklyhq.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/checklyhq/apis/checkly-public-api/docs/v3/status-pages/:statusPageId/components/:componentId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

statusPageIdstring required

componentIdstring required

Headers

x-checkly-accountstring

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Request body

type'SERVICE' | 'GROUP'

namestring required

descriptionstring nullable

displayOrderinteger required

hiddenboolean

parentIdstring nullable

The GROUP component this component sits under. Must belong to the same status page.

Response

Successful