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 '
{
  "type": "HTTP",
  "config": {
    "hostname": "<string>",
    "recordTypes": [
      "A"
    ],
    "nameservers": [
      "<string>"
    ],
    "timeoutMs": 123,
    "totalTimeoutMs": 123
  },
  "assertions": [
    {
      "config": {
        "type": "<string>",
        "substring": "<string>"
      },
      "severity": "fail"
    }
  ]
}
'
{
  "data": {
    "passed": true,
    "error": "<string>",
    "statusCode": 123,
    "responseTimeMs": 123,
    "responseHeaders": {},
    "bodyPreview": "<string>",
    "responseSizeBytes": 123,
    "redirectCount": 123,
    "finalUrl": "<string>",
    "assertionResults": [
      {
        "assertionType": "status_code",
        "passed": true,
        "severity": "fail",
        "message": "<string>",
        "expected": "<string>",
        "actual": "<string>"
      }
    ],
    "warnings": [
      "<string>"
    ]
  }
}

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

Updated protocol-specific configuration; null preserves current

assertions
object[] | null

Optional assertions to evaluate against the test result

Response

200 - */*

OK

data
object