Skip to main content
PUT
Update a monitor

Authorizations

Authorization
string
header
required

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

Headers

X-DevHelm-Client
string

Calling surface and version, e.g. cli/1.4.0 or sdk-js/2.0.0

Path Parameters

id
string<uuid>
required

Body

application/json
name
string | null

New monitor name. Null preserves current

Maximum string length: 255
config
object
frequencySeconds
integer<int32> | null

Check frequency in seconds; minimum depends on plan. Null preserves current

Required range: 10 <= x <= 86400
enabled
boolean | null

Enable or disable the monitor (pause or resume). Null preserves current

regions
string[] | null

New probe regions. Null preserves current. Allowed values are deployment-dependent

New probe regions. Null preserves current. Allowed values are deployment-dependent

managedBy
enum<string> | null

New ownership source for probe monitors. Null preserves current. Code monitors use takeover

Available options:
DASHBOARD,
CLI,
TERRAFORM,
MCP,
API,
GIT
ownerEnforced
boolean | null

Only the managedBy tool may change configuration. Null preserves current

ownerProject
string | null

Project the owning tool declares; null preserves current

Maximum string length: 255
environmentId
string<uuid> | null

New environment; null preserves current

clearEnvironmentId
boolean | null

Set to true to remove the environment association

assertions
object[] | null

Replace all assertions. Null preserves current

auth
object

New authentication configuration (full replacement)

clearAuth
boolean | null

Set to true to remove authentication

incidentPolicy
object | null

Request body for updating an incident policy

alertChannelIds
string<uuid>[] | null

Replace alert channel list. Null preserves current

Replace alert channel list. Null preserves current

tags
object | null

Request body for adding tags to a monitor. Provide existing tag IDs, inline new tags, or both.

capturePolicy
object | null

When to retain screenshots, traces, video, and network evidence

fastRetryMaxAttempts
integer<int32> | null

Fast-retry attempts after failure. Null preserves current. 0 disables

Required range: 0 <= x <= 10
runParallel
boolean | null

Run every location each interval; false rotates one. Null preserves current

code
object | null

Bundle digest and entrypoint to publish as the live revision

acknowledgeRollback
string | null

Rolled-back digest this code publish re-applies on purpose

status
string | null

Not writable; use pause or resume

expectedUpdatedAt
string<date-time> | null

Last updatedAt this edit was based on; null skips the check

secretKeys
string[] | null

Replace attached secret keys; null preserves current

Maximum array length: 256

Replace attached secret keys; null preserves current

Maximum string length: 255

Response

OK

data
object
required

Full monitor representation