Skip to main content
GET
/
api
/
v1
/
monitors
/
{monitorId}
/
policy
Get incident policy for a monitor
curl --request GET \
  --url https://api.devhelm.io/api/v1/monitors/{monitorId}/policy \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.devhelm.io/api/v1/monitors/{monitorId}/policy"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.devhelm.io/api/v1/monitors/{monitorId}/policy', 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/{monitorId}/policy",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

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

func main() {

	url := "https://api.devhelm.io/api/v1/monitors/{monitorId}/policy"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.devhelm.io/api/v1/monitors/{monitorId}/policy")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.devhelm.io/api/v1/monitors/{monitorId}/policy")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "triggerRules": [
    {
      "count": 123,
      "windowMinutes": 123,
      "thresholdMs": 123
    }
  ],
  "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
}
{
  "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"
}
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "triggerRules": [
      {
        "count": 123,
        "windowMinutes": 123,
        "thresholdMs": 123
      }
    ],
    "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
  }
}
{
  "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

Path Parameters

monitorId
string<uuid>
required

Monitor UUID

Response

Policy found

Incident detection, confirmation, and recovery policy for a monitor

id
string<uuid>
required

Unique incident policy identifier

monitorId
string<uuid>
required

Monitor this policy is attached to

triggerRules
object[]
required

Array of trigger rules defining when an incident should be raised

confirmation
object
required

Multi-region confirmation settings

recovery
object
required

Auto-recovery settings

createdAt
string<date-time>
required

Timestamp when the policy was created

updatedAt
string<date-time>
required

Timestamp when the policy was last updated

monitorRegionCount
integer<int32> | null

Number of regions configured on the monitor (only set in internal API responses)

checkFrequencySeconds
integer<int32> | null

Monitor check frequency in seconds (only set in internal API responses)