Skip to main content
POST
Ad-hoc monitor test

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
type
enum<string>
required

Monitor protocol type to test

Available options:
HTTP,
DNS,
MCP_SERVER,
TCP,
ICMP,
HEARTBEAT,
BROWSER,
MULTI_STEP_API
config
object
assertions
object[] | null

Optional assertions to evaluate against the test result

environmentId
string<uuid> | null

Environment to run in; required for browser and multi-step API code

code
object | null

Bundle digest and entrypoint to publish as the live revision

session
object | null

CI session that started this run; absent on historical runs

region
string | null

Probe region for a code-bundle test (default: us-east)

Maximum string length: 64

Response

Probe result for an uptime monitor

data
object
required