Skip to main content
POST
Upsert status page component

Restrictions

Usage

  • An item without component_id creates a component; an item with component_id updates that component.
  • An update overwrites name, description, section_id, order_id, hide_uptime, and hide_all with the values sent, so omitted fields are reset (omitting section_id moves the component to the top level); available_since_seconds is ignored on update.
  • Component names must be unique within the page and section_id must be an existing section; any invalid item rejects the whole request.
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Parameters for creating or updating one or more service components on a status page.

page_id
integer<int64>
required

Status page ID; obtain it from GET /status-page/list.

components
object[]
required

Components to create or update.

Minimum array length: 1

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Result of upserting status page components.