Skip to main content
POST
Create a new monitor

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Replays the stored response for 24h when the same key is sent again (1–255 visible ASCII)

X-DevHelm-Client
string

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

Body

application/json
name
string
required

Human-readable name for this monitor

Maximum string length: 255
type
enum<string>
required

Monitor protocol type

Available options:
HTTP,
DNS,
MCP_SERVER,
TCP,
ICMP,
HEARTBEAT,
BROWSER,
MULTI_STEP_API
config
object
frequencySeconds
integer<int32> | null

Check frequency in seconds; minimum depends on plan (default: plan minimum)

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

Whether the monitor is active (default: true)

regions
string[] | null

Probe regions to run checks from. Allowed values are deployment-dependent. Production: us-east, us-west, eu-west, ap-south

Probe regions to run checks from. Allowed values are deployment-dependent. Production: us-east, us-west, eu-west, ap-south

managedBy
enum<string> | null

Source that created this monitor: DASHBOARD, GIT, TERRAFORM, MCP or API (CLI = GIT until 2027-01-31). Defaults to API

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

Only the managedBy tool may change configuration (default: false)

ownerProject
string | null

Project the owning tool declares for this monitor, e.g. acme/web

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

Environment to associate with this monitor. Required for browser and multi-step monitors

assertions
object[] | null

Assertions to evaluate against each check result

auth
object

New authentication configuration (full replacement)

incidentPolicy
object | null

Request body for updating an incident policy

alertChannelIds
string<uuid>[] | null

Alert channels to notify when this monitor triggers

Alert channels to notify when this monitor triggers

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 or 0 disables

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

When multiple locations are set, run all of them each interval (default: true). false rotates one location per interval

definitionId
string<uuid> | null

Existing definition to reuse for a sibling monitor

code
object | null

Bundle digest and entrypoint to publish as the live revision

ownerDeclaration
object | null

Advisory location and label declared by the owner

secretKeys
string[] | null

Secret keys to attach; null starts with the scanned set

Maximum array length: 256

Secret keys to attach; null starts with the scanned set

Maximum string length: 255

Response

Created

data
object
required

Full monitor representation