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>'
{
  "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
}

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>

Unique incident policy identifier

monitorId
string<uuid>

Monitor this policy is attached to

triggerRules
object[]

Array of trigger rules defining when an incident should be raised

confirmation
object

Multi-region confirmation settings

recovery
object

Auto-recovery settings

createdAt
string<date-time>

Timestamp when the policy was created

updatedAt
string<date-time>

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)