Skip to main content
POST
Add a component to the status page

Authorizations

Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
required

Component display name

Maximum string length: 255
type
enum<string>
required

Component type: MONITOR, GROUP, or STATIC

Available options:
MONITOR,
GROUP,
STATIC
description
string | null

Optional description shown on expand

Maximum string length: 500
monitorId
string<uuid> | null

Monitor ID (required when type=MONITOR)

resourceGroupId
string<uuid> | null

Resource group ID (required when type=GROUP)

groupId
string<uuid> | null

Component group ID for visual grouping

showUptime
boolean | null

Whether to show the uptime bar (default: true)

displayOrder
integer<int32> | null

Position in the component list

excludeFromOverall
boolean | null

Exclude from overall status calculation (default: false, use true for third-party deps)

startDate
string<date> | null

Date from which to start showing uptime; defaults to component creation. Set earlier to backdate (e.g. launch day); clamped at the monitor's createdAt for MONITOR-type components

Response

Created

data
object
required