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": {
        "type": "body_contains",
        "substring": "<string>"
      }
    }
  ]
}
'
import requests

url = "https://api.devhelm.io/api/v1/monitors/test"

payload = {
"config": {
"hostname": "<string>",
"recordTypes": [],
"nameservers": ["<string>"],
"timeoutMs": 123,
"totalTimeoutMs": 123
},
"assertions": [{ "config": {
"type": "body_contains",
"substring": "<string>"
} }]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
config: {
hostname: '<string>',
recordTypes: [],
nameservers: ['<string>'],
timeoutMs: 123,
totalTimeoutMs: 123
},
assertions: [{config: {type: 'body_contains', substring: '<string>'}}]
})
};

fetch('https://api.devhelm.io/api/v1/monitors/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.devhelm.io/api/v1/monitors/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'config' => [
'hostname' => '<string>',
'recordTypes' => [

],
'nameservers' => [
'<string>'
],
'timeoutMs' => 123,
'totalTimeoutMs' => 123
],
'assertions' => [
[
'config' => [
'type' => 'body_contains',
'substring' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.devhelm.io/api/v1/monitors/test"

payload := strings.NewReader("{\n \"config\": {\n \"hostname\": \"<string>\",\n \"recordTypes\": [],\n \"nameservers\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"totalTimeoutMs\": 123\n },\n \"assertions\": [\n {\n \"config\": {\n \"type\": \"body_contains\",\n \"substring\": \"<string>\"\n }\n }\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.devhelm.io/api/v1/monitors/test")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"hostname\": \"<string>\",\n \"recordTypes\": [],\n \"nameservers\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"totalTimeoutMs\": 123\n },\n \"assertions\": [\n {\n \"config\": {\n \"type\": \"body_contains\",\n \"substring\": \"<string>\"\n }\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.devhelm.io/api/v1/monitors/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"hostname\": \"<string>\",\n \"recordTypes\": [],\n \"nameservers\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"totalTimeoutMs\": 123\n },\n \"assertions\": [\n {\n \"config\": {\n \"type\": \"body_contains\",\n \"substring\": \"<string>\"\n }\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "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>"
    ]
  }
}
{
"status": 404,
"code": "NOT_FOUND",
"message": "Monitor not found",
"timestamp": 1737302400000,
"requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
"status": 404,
"code": "NOT_FOUND",
"message": "Monitor not found",
"timestamp": 1737302400000,
"requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
"status": 404,
"code": "NOT_FOUND",
"message": "Monitor not found",
"timestamp": 1737302400000,
"requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
"status": 404,
"code": "NOT_FOUND",
"message": "Monitor not found",
"timestamp": 1737302400000,
"requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
"status": 404,
"code": "NOT_FOUND",
"message": "Monitor not found",
"timestamp": 1737302400000,
"requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
"status": 404,
"code": "NOT_FOUND",
"message": "Monitor not found",
"timestamp": 1737302400000,
"requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
"status": 404,
"code": "NOT_FOUND",
"message": "Monitor not found",
"timestamp": 1737302400000,
"requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
"status": 404,
"code": "NOT_FOUND",
"message": "Monitor not found",
"timestamp": 1737302400000,
"requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}

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,
BROWSER,
MULTI_STEP_API
config
object
required
assertions
object[] | null

Optional assertions to evaluate against the test result

Response

OK

data
object
required