Skip to main content
PUT
Update a component

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required
componentId
string<uuid>
required

Body

application/json
name
string | null

New component name; null preserves current

Maximum string length: 255
description
string | null

New description; null preserves current, empty string clears

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

Move to a different group; null preserves current

removeFromGroup
boolean | null

Remove the component from its group (default: false)

showUptime
boolean | null

Whether to show the uptime bar; null preserves current

displayOrder
integer<int32> | null

New position in the component list; null preserves current

excludeFromOverall
boolean | null

Exclude from overall status calculation; null preserves current

startDate
string<date> | null

Date from which to start showing uptime; null preserves current. Bars never extend earlier than the underlying monitor's createdAt regardless of value

Response

OK

data
object
required