Skip to main content
POST
/
api
/
v1
/
monitors
/
test
Ad-hoc monitor test
curl --request POST \
  --url https://api.devhelm.io/api/v1/monitors/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "hostname": "<string>",
    "recordTypes": [],
    "nameservers": [
      "<string>"
    ],
    "timeoutMs": 123,
    "totalTimeoutMs": 123
  },
  "assertions": [
    {
      "config": {
        "substring": "<string>"
      }
    }
  ]
}
'
{
  "data": {
    "passed": true,
    "assertionResults": [
      {
        "passed": true,
        "message": "<string>",
        "expected": "<string>",
        "actual": "<string>"
      }
    ],
    "error": "<string>",
    "statusCode": 123,
    "responseTimeMs": 123,
    "responseHeaders": {},
    "bodyPreview": "<string>",
    "responseSizeBytes": 123,
    "redirectCount": 123,
    "finalUrl": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.devhelm.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Body

application/json
type
enum<string>
required

Monitor protocol type to test

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

Optional assertions to evaluate against the test result

Response

OK

data
object
required