Create a new monitor
curl --request POST \
--url https://api.devhelm.io/api/v1/monitors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"config": {
"hostname": "<string>",
"recordTypes": [],
"nameservers": [
"<string>"
],
"timeoutMs": 123,
"totalTimeoutMs": 123
},
"frequencySeconds": 43205,
"enabled": true,
"regions": [
"<string>"
],
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assertions": [
{
"config": {
"type": "body_contains",
"substring": "<string>"
}
}
],
"auth": {
"type": "bearer",
"vaultSecretId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"incidentPolicy": {
"triggerRules": [
{
"count": 123,
"windowMinutes": 123,
"thresholdMs": 123
}
],
"confirmation": {
"type": "multi_region",
"minRegionsFailing": 123,
"maxWaitSeconds": 123
},
"recovery": {
"consecutiveSuccesses": 123,
"minRegionsPassing": 123,
"cooldownMinutes": 123
}
},
"alertChannelIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tags": {
"tagIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"newTags": [
{
"name": "<string>",
"color": "<string>"
}
]
},
"capturePolicy": {},
"fastRetryMaxAttempts": 5,
"definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"package": {
"digest": "<string>",
"entrypoint": "<string>",
"files": [
"<string>"
],
"keys": [
"<string>"
],
"gitSha": "<string>",
"gitMessage": "<string>",
"gitFile": "<string>",
"authoredBy": "<string>"
}
}
'import requests
url = "https://api.devhelm.io/api/v1/monitors"
payload = {
"name": "<string>",
"config": {
"hostname": "<string>",
"recordTypes": [],
"nameservers": ["<string>"],
"timeoutMs": 123,
"totalTimeoutMs": 123
},
"frequencySeconds": 43205,
"enabled": True,
"regions": ["<string>"],
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assertions": [{ "config": {
"type": "body_contains",
"substring": "<string>"
} }],
"auth": {
"type": "bearer",
"vaultSecretId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"incidentPolicy": {
"triggerRules": [
{
"count": 123,
"windowMinutes": 123,
"thresholdMs": 123
}
],
"confirmation": {
"type": "multi_region",
"minRegionsFailing": 123,
"maxWaitSeconds": 123
},
"recovery": {
"consecutiveSuccesses": 123,
"minRegionsPassing": 123,
"cooldownMinutes": 123
}
},
"alertChannelIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"tags": {
"tagIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"newTags": [
{
"name": "<string>",
"color": "<string>"
}
]
},
"capturePolicy": {},
"fastRetryMaxAttempts": 5,
"definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"package": {
"digest": "<string>",
"entrypoint": "<string>",
"files": ["<string>"],
"keys": ["<string>"],
"gitSha": "<string>",
"gitMessage": "<string>",
"gitFile": "<string>",
"authoredBy": "<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({
name: '<string>',
config: {
hostname: '<string>',
recordTypes: [],
nameservers: ['<string>'],
timeoutMs: 123,
totalTimeoutMs: 123
},
frequencySeconds: 43205,
enabled: true,
regions: ['<string>'],
environmentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
assertions: [{config: {type: 'body_contains', substring: '<string>'}}],
auth: {type: 'bearer', vaultSecretId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
incidentPolicy: {
triggerRules: [{count: 123, windowMinutes: 123, thresholdMs: 123}],
confirmation: {type: 'multi_region', minRegionsFailing: 123, maxWaitSeconds: 123},
recovery: {consecutiveSuccesses: 123, minRegionsPassing: 123, cooldownMinutes: 123}
},
alertChannelIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
tags: {
tagIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
newTags: [{name: '<string>', color: '<string>'}]
},
capturePolicy: {},
fastRetryMaxAttempts: 5,
definitionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
package: {
digest: '<string>',
entrypoint: '<string>',
files: ['<string>'],
keys: ['<string>'],
gitSha: '<string>',
gitMessage: '<string>',
gitFile: '<string>',
authoredBy: '<string>'
}
})
};
fetch('https://api.devhelm.io/api/v1/monitors', 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",
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([
'name' => '<string>',
'config' => [
'hostname' => '<string>',
'recordTypes' => [
],
'nameservers' => [
'<string>'
],
'timeoutMs' => 123,
'totalTimeoutMs' => 123
],
'frequencySeconds' => 43205,
'enabled' => true,
'regions' => [
'<string>'
],
'environmentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'assertions' => [
[
'config' => [
'type' => 'body_contains',
'substring' => '<string>'
]
]
],
'auth' => [
'type' => 'bearer',
'vaultSecretId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'incidentPolicy' => [
'triggerRules' => [
[
'count' => 123,
'windowMinutes' => 123,
'thresholdMs' => 123
]
],
'confirmation' => [
'type' => 'multi_region',
'minRegionsFailing' => 123,
'maxWaitSeconds' => 123
],
'recovery' => [
'consecutiveSuccesses' => 123,
'minRegionsPassing' => 123,
'cooldownMinutes' => 123
]
],
'alertChannelIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'tags' => [
'tagIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'newTags' => [
[
'name' => '<string>',
'color' => '<string>'
]
]
],
'capturePolicy' => [
],
'fastRetryMaxAttempts' => 5,
'definitionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'package' => [
'digest' => '<string>',
'entrypoint' => '<string>',
'files' => [
'<string>'
],
'keys' => [
'<string>'
],
'gitSha' => '<string>',
'gitMessage' => '<string>',
'gitFile' => '<string>',
'authoredBy' => '<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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"config\": {\n \"hostname\": \"<string>\",\n \"recordTypes\": [],\n \"nameservers\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"totalTimeoutMs\": 123\n },\n \"frequencySeconds\": 43205,\n \"enabled\": true,\n \"regions\": [\n \"<string>\"\n ],\n \"environmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assertions\": [\n {\n \"config\": {\n \"type\": \"body_contains\",\n \"substring\": \"<string>\"\n }\n }\n ],\n \"auth\": {\n \"type\": \"bearer\",\n \"vaultSecretId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"incidentPolicy\": {\n \"triggerRules\": [\n {\n \"count\": 123,\n \"windowMinutes\": 123,\n \"thresholdMs\": 123\n }\n ],\n \"confirmation\": {\n \"type\": \"multi_region\",\n \"minRegionsFailing\": 123,\n \"maxWaitSeconds\": 123\n },\n \"recovery\": {\n \"consecutiveSuccesses\": 123,\n \"minRegionsPassing\": 123,\n \"cooldownMinutes\": 123\n }\n },\n \"alertChannelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"tags\": {\n \"tagIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"newTags\": [\n {\n \"name\": \"<string>\",\n \"color\": \"<string>\"\n }\n ]\n },\n \"capturePolicy\": {},\n \"fastRetryMaxAttempts\": 5,\n \"definitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"package\": {\n \"digest\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"files\": [\n \"<string>\"\n ],\n \"keys\": [\n \"<string>\"\n ],\n \"gitSha\": \"<string>\",\n \"gitMessage\": \"<string>\",\n \"gitFile\": \"<string>\",\n \"authoredBy\": \"<string>\"\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": {\n \"hostname\": \"<string>\",\n \"recordTypes\": [],\n \"nameservers\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"totalTimeoutMs\": 123\n },\n \"frequencySeconds\": 43205,\n \"enabled\": true,\n \"regions\": [\n \"<string>\"\n ],\n \"environmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assertions\": [\n {\n \"config\": {\n \"type\": \"body_contains\",\n \"substring\": \"<string>\"\n }\n }\n ],\n \"auth\": {\n \"type\": \"bearer\",\n \"vaultSecretId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"incidentPolicy\": {\n \"triggerRules\": [\n {\n \"count\": 123,\n \"windowMinutes\": 123,\n \"thresholdMs\": 123\n }\n ],\n \"confirmation\": {\n \"type\": \"multi_region\",\n \"minRegionsFailing\": 123,\n \"maxWaitSeconds\": 123\n },\n \"recovery\": {\n \"consecutiveSuccesses\": 123,\n \"minRegionsPassing\": 123,\n \"cooldownMinutes\": 123\n }\n },\n \"alertChannelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"tags\": {\n \"tagIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"newTags\": [\n {\n \"name\": \"<string>\",\n \"color\": \"<string>\"\n }\n ]\n },\n \"capturePolicy\": {},\n \"fastRetryMaxAttempts\": 5,\n \"definitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"package\": {\n \"digest\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"files\": [\n \"<string>\"\n ],\n \"keys\": [\n \"<string>\"\n ],\n \"gitSha\": \"<string>\",\n \"gitMessage\": \"<string>\",\n \"gitFile\": \"<string>\",\n \"authoredBy\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.devhelm.io/api/v1/monitors")
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 \"name\": \"<string>\",\n \"config\": {\n \"hostname\": \"<string>\",\n \"recordTypes\": [],\n \"nameservers\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"totalTimeoutMs\": 123\n },\n \"frequencySeconds\": 43205,\n \"enabled\": true,\n \"regions\": [\n \"<string>\"\n ],\n \"environmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assertions\": [\n {\n \"config\": {\n \"type\": \"body_contains\",\n \"substring\": \"<string>\"\n }\n }\n ],\n \"auth\": {\n \"type\": \"bearer\",\n \"vaultSecretId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"incidentPolicy\": {\n \"triggerRules\": [\n {\n \"count\": 123,\n \"windowMinutes\": 123,\n \"thresholdMs\": 123\n }\n ],\n \"confirmation\": {\n \"type\": \"multi_region\",\n \"minRegionsFailing\": 123,\n \"maxWaitSeconds\": 123\n },\n \"recovery\": {\n \"consecutiveSuccesses\": 123,\n \"minRegionsPassing\": 123,\n \"cooldownMinutes\": 123\n }\n },\n \"alertChannelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"tags\": {\n \"tagIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"newTags\": [\n {\n \"name\": \"<string>\",\n \"color\": \"<string>\"\n }\n ]\n },\n \"capturePolicy\": {},\n \"fastRetryMaxAttempts\": 5,\n \"definitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"package\": {\n \"digest\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"files\": [\n \"<string>\"\n ],\n \"keys\": [\n \"<string>\"\n ],\n \"gitSha\": \"<string>\",\n \"gitMessage\": \"<string>\",\n \"gitFile\": \"<string>\",\n \"authoredBy\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": 123,
"name": "<string>",
"type": "HTTP",
"config": {
"hostname": "<string>",
"recordTypes": [
"A"
],
"nameservers": [
"<string>"
],
"timeoutMs": 123,
"totalTimeoutMs": 123
},
"frequencySeconds": 123,
"enabled": true,
"regions": [
"<string>"
],
"managedBy": "DASHBOARD",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"muted": true,
"assertions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assertionType": "status_code",
"config": {
"type": "body_contains",
"substring": "<string>"
},
"severity": "fail"
}
],
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": 123,
"name": "<string>",
"color": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"pingUrl": "<string>",
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>"
},
"auth": {
"type": "bearer",
"vaultSecretId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"incidentPolicy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"triggerRules": [
{
"type": "consecutive_failures",
"scope": "per_region",
"severity": "down",
"count": 123,
"windowMinutes": 123,
"thresholdMs": 123,
"aggregationType": "all_exceed"
}
],
"confirmation": {
"type": "multi_region",
"minRegionsFailing": 123,
"maxWaitSeconds": 123
},
"recovery": {
"consecutiveSuccesses": 123,
"minRegionsPassing": 123,
"cooldownMinutes": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"monitorRegionCount": 123,
"checkFrequencySeconds": 123
},
"alertChannelIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"currentStatus": "up",
"definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"capturePolicy": {
"screenshots": "always",
"trace": "always",
"video": "always"
},
"fastRetryMaxAttempts": 123,
"mutedUntil": "2023-11-07T05:31:56Z",
"muteReason": "<string>",
"pausedAt": "2023-11-07T05:31:56Z",
"pauseReason": "<string>",
"pauseExpiresAt": "2023-11-07T05:31:56Z",
"quarantineOwnerId": "<string>",
"quarantineUntil": "2023-11-07T05:31:56Z",
"quarantineReason": "<string>",
"upload": {
"putUrl": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"requiredHeaders": {}
}
}
}{
"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"
}Monitors
Create a new monitor
POST
/
api
/
v1
/
monitors
Create a new monitor
curl --request POST \
--url https://api.devhelm.io/api/v1/monitors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"config": {
"hostname": "<string>",
"recordTypes": [],
"nameservers": [
"<string>"
],
"timeoutMs": 123,
"totalTimeoutMs": 123
},
"frequencySeconds": 43205,
"enabled": true,
"regions": [
"<string>"
],
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assertions": [
{
"config": {
"type": "body_contains",
"substring": "<string>"
}
}
],
"auth": {
"type": "bearer",
"vaultSecretId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"incidentPolicy": {
"triggerRules": [
{
"count": 123,
"windowMinutes": 123,
"thresholdMs": 123
}
],
"confirmation": {
"type": "multi_region",
"minRegionsFailing": 123,
"maxWaitSeconds": 123
},
"recovery": {
"consecutiveSuccesses": 123,
"minRegionsPassing": 123,
"cooldownMinutes": 123
}
},
"alertChannelIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tags": {
"tagIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"newTags": [
{
"name": "<string>",
"color": "<string>"
}
]
},
"capturePolicy": {},
"fastRetryMaxAttempts": 5,
"definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"package": {
"digest": "<string>",
"entrypoint": "<string>",
"files": [
"<string>"
],
"keys": [
"<string>"
],
"gitSha": "<string>",
"gitMessage": "<string>",
"gitFile": "<string>",
"authoredBy": "<string>"
}
}
'import requests
url = "https://api.devhelm.io/api/v1/monitors"
payload = {
"name": "<string>",
"config": {
"hostname": "<string>",
"recordTypes": [],
"nameservers": ["<string>"],
"timeoutMs": 123,
"totalTimeoutMs": 123
},
"frequencySeconds": 43205,
"enabled": True,
"regions": ["<string>"],
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assertions": [{ "config": {
"type": "body_contains",
"substring": "<string>"
} }],
"auth": {
"type": "bearer",
"vaultSecretId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"incidentPolicy": {
"triggerRules": [
{
"count": 123,
"windowMinutes": 123,
"thresholdMs": 123
}
],
"confirmation": {
"type": "multi_region",
"minRegionsFailing": 123,
"maxWaitSeconds": 123
},
"recovery": {
"consecutiveSuccesses": 123,
"minRegionsPassing": 123,
"cooldownMinutes": 123
}
},
"alertChannelIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"tags": {
"tagIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"newTags": [
{
"name": "<string>",
"color": "<string>"
}
]
},
"capturePolicy": {},
"fastRetryMaxAttempts": 5,
"definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"package": {
"digest": "<string>",
"entrypoint": "<string>",
"files": ["<string>"],
"keys": ["<string>"],
"gitSha": "<string>",
"gitMessage": "<string>",
"gitFile": "<string>",
"authoredBy": "<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({
name: '<string>',
config: {
hostname: '<string>',
recordTypes: [],
nameservers: ['<string>'],
timeoutMs: 123,
totalTimeoutMs: 123
},
frequencySeconds: 43205,
enabled: true,
regions: ['<string>'],
environmentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
assertions: [{config: {type: 'body_contains', substring: '<string>'}}],
auth: {type: 'bearer', vaultSecretId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
incidentPolicy: {
triggerRules: [{count: 123, windowMinutes: 123, thresholdMs: 123}],
confirmation: {type: 'multi_region', minRegionsFailing: 123, maxWaitSeconds: 123},
recovery: {consecutiveSuccesses: 123, minRegionsPassing: 123, cooldownMinutes: 123}
},
alertChannelIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
tags: {
tagIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
newTags: [{name: '<string>', color: '<string>'}]
},
capturePolicy: {},
fastRetryMaxAttempts: 5,
definitionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
package: {
digest: '<string>',
entrypoint: '<string>',
files: ['<string>'],
keys: ['<string>'],
gitSha: '<string>',
gitMessage: '<string>',
gitFile: '<string>',
authoredBy: '<string>'
}
})
};
fetch('https://api.devhelm.io/api/v1/monitors', 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",
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([
'name' => '<string>',
'config' => [
'hostname' => '<string>',
'recordTypes' => [
],
'nameservers' => [
'<string>'
],
'timeoutMs' => 123,
'totalTimeoutMs' => 123
],
'frequencySeconds' => 43205,
'enabled' => true,
'regions' => [
'<string>'
],
'environmentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'assertions' => [
[
'config' => [
'type' => 'body_contains',
'substring' => '<string>'
]
]
],
'auth' => [
'type' => 'bearer',
'vaultSecretId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'incidentPolicy' => [
'triggerRules' => [
[
'count' => 123,
'windowMinutes' => 123,
'thresholdMs' => 123
]
],
'confirmation' => [
'type' => 'multi_region',
'minRegionsFailing' => 123,
'maxWaitSeconds' => 123
],
'recovery' => [
'consecutiveSuccesses' => 123,
'minRegionsPassing' => 123,
'cooldownMinutes' => 123
]
],
'alertChannelIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'tags' => [
'tagIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'newTags' => [
[
'name' => '<string>',
'color' => '<string>'
]
]
],
'capturePolicy' => [
],
'fastRetryMaxAttempts' => 5,
'definitionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'package' => [
'digest' => '<string>',
'entrypoint' => '<string>',
'files' => [
'<string>'
],
'keys' => [
'<string>'
],
'gitSha' => '<string>',
'gitMessage' => '<string>',
'gitFile' => '<string>',
'authoredBy' => '<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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"config\": {\n \"hostname\": \"<string>\",\n \"recordTypes\": [],\n \"nameservers\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"totalTimeoutMs\": 123\n },\n \"frequencySeconds\": 43205,\n \"enabled\": true,\n \"regions\": [\n \"<string>\"\n ],\n \"environmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assertions\": [\n {\n \"config\": {\n \"type\": \"body_contains\",\n \"substring\": \"<string>\"\n }\n }\n ],\n \"auth\": {\n \"type\": \"bearer\",\n \"vaultSecretId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"incidentPolicy\": {\n \"triggerRules\": [\n {\n \"count\": 123,\n \"windowMinutes\": 123,\n \"thresholdMs\": 123\n }\n ],\n \"confirmation\": {\n \"type\": \"multi_region\",\n \"minRegionsFailing\": 123,\n \"maxWaitSeconds\": 123\n },\n \"recovery\": {\n \"consecutiveSuccesses\": 123,\n \"minRegionsPassing\": 123,\n \"cooldownMinutes\": 123\n }\n },\n \"alertChannelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"tags\": {\n \"tagIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"newTags\": [\n {\n \"name\": \"<string>\",\n \"color\": \"<string>\"\n }\n ]\n },\n \"capturePolicy\": {},\n \"fastRetryMaxAttempts\": 5,\n \"definitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"package\": {\n \"digest\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"files\": [\n \"<string>\"\n ],\n \"keys\": [\n \"<string>\"\n ],\n \"gitSha\": \"<string>\",\n \"gitMessage\": \"<string>\",\n \"gitFile\": \"<string>\",\n \"authoredBy\": \"<string>\"\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": {\n \"hostname\": \"<string>\",\n \"recordTypes\": [],\n \"nameservers\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"totalTimeoutMs\": 123\n },\n \"frequencySeconds\": 43205,\n \"enabled\": true,\n \"regions\": [\n \"<string>\"\n ],\n \"environmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assertions\": [\n {\n \"config\": {\n \"type\": \"body_contains\",\n \"substring\": \"<string>\"\n }\n }\n ],\n \"auth\": {\n \"type\": \"bearer\",\n \"vaultSecretId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"incidentPolicy\": {\n \"triggerRules\": [\n {\n \"count\": 123,\n \"windowMinutes\": 123,\n \"thresholdMs\": 123\n }\n ],\n \"confirmation\": {\n \"type\": \"multi_region\",\n \"minRegionsFailing\": 123,\n \"maxWaitSeconds\": 123\n },\n \"recovery\": {\n \"consecutiveSuccesses\": 123,\n \"minRegionsPassing\": 123,\n \"cooldownMinutes\": 123\n }\n },\n \"alertChannelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"tags\": {\n \"tagIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"newTags\": [\n {\n \"name\": \"<string>\",\n \"color\": \"<string>\"\n }\n ]\n },\n \"capturePolicy\": {},\n \"fastRetryMaxAttempts\": 5,\n \"definitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"package\": {\n \"digest\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"files\": [\n \"<string>\"\n ],\n \"keys\": [\n \"<string>\"\n ],\n \"gitSha\": \"<string>\",\n \"gitMessage\": \"<string>\",\n \"gitFile\": \"<string>\",\n \"authoredBy\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.devhelm.io/api/v1/monitors")
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 \"name\": \"<string>\",\n \"config\": {\n \"hostname\": \"<string>\",\n \"recordTypes\": [],\n \"nameservers\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"totalTimeoutMs\": 123\n },\n \"frequencySeconds\": 43205,\n \"enabled\": true,\n \"regions\": [\n \"<string>\"\n ],\n \"environmentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assertions\": [\n {\n \"config\": {\n \"type\": \"body_contains\",\n \"substring\": \"<string>\"\n }\n }\n ],\n \"auth\": {\n \"type\": \"bearer\",\n \"vaultSecretId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"incidentPolicy\": {\n \"triggerRules\": [\n {\n \"count\": 123,\n \"windowMinutes\": 123,\n \"thresholdMs\": 123\n }\n ],\n \"confirmation\": {\n \"type\": \"multi_region\",\n \"minRegionsFailing\": 123,\n \"maxWaitSeconds\": 123\n },\n \"recovery\": {\n \"consecutiveSuccesses\": 123,\n \"minRegionsPassing\": 123,\n \"cooldownMinutes\": 123\n }\n },\n \"alertChannelIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"tags\": {\n \"tagIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"newTags\": [\n {\n \"name\": \"<string>\",\n \"color\": \"<string>\"\n }\n ]\n },\n \"capturePolicy\": {},\n \"fastRetryMaxAttempts\": 5,\n \"definitionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"package\": {\n \"digest\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"files\": [\n \"<string>\"\n ],\n \"keys\": [\n \"<string>\"\n ],\n \"gitSha\": \"<string>\",\n \"gitMessage\": \"<string>\",\n \"gitFile\": \"<string>\",\n \"authoredBy\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": 123,
"name": "<string>",
"type": "HTTP",
"config": {
"hostname": "<string>",
"recordTypes": [
"A"
],
"nameservers": [
"<string>"
],
"timeoutMs": 123,
"totalTimeoutMs": 123
},
"frequencySeconds": 123,
"enabled": true,
"regions": [
"<string>"
],
"managedBy": "DASHBOARD",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"muted": true,
"assertions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assertionType": "status_code",
"config": {
"type": "body_contains",
"substring": "<string>"
},
"severity": "fail"
}
],
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": 123,
"name": "<string>",
"color": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"pingUrl": "<string>",
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"slug": "<string>"
},
"auth": {
"type": "bearer",
"vaultSecretId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"incidentPolicy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"triggerRules": [
{
"type": "consecutive_failures",
"scope": "per_region",
"severity": "down",
"count": 123,
"windowMinutes": 123,
"thresholdMs": 123,
"aggregationType": "all_exceed"
}
],
"confirmation": {
"type": "multi_region",
"minRegionsFailing": 123,
"maxWaitSeconds": 123
},
"recovery": {
"consecutiveSuccesses": 123,
"minRegionsPassing": 123,
"cooldownMinutes": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"monitorRegionCount": 123,
"checkFrequencySeconds": 123
},
"alertChannelIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"currentStatus": "up",
"definitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"capturePolicy": {
"screenshots": "always",
"trace": "always",
"video": "always"
},
"fastRetryMaxAttempts": 123,
"mutedUntil": "2023-11-07T05:31:56Z",
"muteReason": "<string>",
"pausedAt": "2023-11-07T05:31:56Z",
"pauseReason": "<string>",
"pauseExpiresAt": "2023-11-07T05:31:56Z",
"quarantineOwnerId": "<string>",
"quarantineUntil": "2023-11-07T05:31:56Z",
"quarantineReason": "<string>",
"upload": {
"putUrl": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"requiredHeaders": {}
}
}
}{
"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
API key (dh_live_...) or Auth0 JWT token
Body
application/json
Human-readable name for this monitor
Maximum string length:
255Monitor protocol type
Available options:
HTTP, DNS, MCP_SERVER, TCP, ICMP, HEARTBEAT, BROWSER, MULTI_STEP_API - Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
Show child attributes
Show child attributes
Check frequency in seconds (10–86400). Null defaults to the plan minimum
Required range:
10 <= x <= 86400Whether the monitor is active (default: true)
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
Source that created this monitor: DASHBOARD, CLI, TERRAFORM, MCP, or API. Defaults to API
Available options:
DASHBOARD, CLI, TERRAFORM, MCP, API Environment to associate with this monitor. Required for browser and multi-step monitors
Assertions to evaluate against each check result
Show child attributes
Show child attributes
New authentication configuration (full replacement)
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Request body for updating an incident policy
Show child attributes
Show child attributes
Alert channels to notify when this monitor triggers
Alert channels to notify when this monitor triggers
Request body for adding tags to a monitor. Provide existing tag IDs, inline new tags, or both.
Show child attributes
Show child attributes
When to capture screenshots, traces, and video during a code run
Show child attributes
Show child attributes
Fast-retry attempts after failure. Null or 0 disables
Required range:
0 <= x <= 10Existing definition to reuse for a sibling monitor
New package zip metadata for this environment
Show child attributes
Show child attributes
Response
Created
Full monitor representation
Show child attributes
Show child attributes