OrkStageOrkStage
API referencestatus

PATCH /status-pages/{tenantId}/components/{componentId}

PATCH /status-pages/{tenantId}/components/{componentId}: OrkStage Control API v1 endpoint reference.

PATCH
/api/v1/status-pages/{tenantId}/components/{componentId}

Authorization

headerAuthorizationBearer <ork_<env>_<id>_<secret>>

Organization API key (scoped). Sessions use the cookie instead.

Path Parameters

tenantId*string
componentId*string

Header Parameters

x-orkstage-csrf?unknown

Cookie sessions: send "1" on POST/PATCH/PUT/DELETE. Not needed with an API key.

Request Body

application/json
  1. body
label?|null
hidden?boolean
sortOrder?|null

Response Body

Example Request
curl -X PATCH 'http://localhost:4000/api/v1/status-pages/string/components/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
Empty
Edit on GitHub

PUT /status-pages/{tenantId} PUT

PUT /status-pages/{tenantId}: OrkStage Control API v1 endpoint reference.

DELETE /status-pages/{tenantId}/subscription DELETE

DELETE /status-pages/{tenantId}/subscription: OrkStage Control API v1 endpoint reference.