OrkStageOrkStage
API referencestatus

PUT /status-pages/{tenantId}

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

PUT
/api/v1/status-pages/{tenantId}

Authorization

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

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

Path Parameters

tenantId*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
visibility*string
Value in"PRIVATE""CUSTOMER_ONLY""PUBLIC"
slug?|
Defaultnull
title?|
Defaultnull
description?|
Defaultnull

Response Body

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

GET /status-pages/{tenantId}/settings GET

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

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

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