Skip to main content
POST
/
api
/
v1
/
notification-policies
/
{id}
/
test
Dry-run: evaluate a policy's match rules against a supplied incident context
curl --request POST \
  --url https://api.devhelm.io/api/v1/notification-policies/{id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "severity": "<string>",
  "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "regions": [
    "<string>"
  ],
  "eventType": "<string>",
  "monitorType": "<string>",
  "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "componentName": "<string>",
  "resourceGroupIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "data": {
    "matched": true,
    "matchedRules": [
      "<string>"
    ],
    "unmatchedRules": [
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Path Parameters

​
id
string<uuid>
required

Body

application/json

Event context for a dry-run match evaluation against a notification policy

​
severity
string | null

Incident severity to test against (e.g. DOWN, DEGRADED, MAINTENANCE)

​
monitorId
string<uuid> | null

Monitor UUID to test against (monitoring events)

​
regions
(string | null)[] | null

Affected region identifiers to test against (monitoring events)

Affected region identifiers to test against (monitoring events)

​
eventType
string | null

Incident event type to test against — short form (e.g. created, resolved, reopened) or full form (e.g. incident.created)

​
monitorType
string | null

Monitor check type to test against (e.g. HTTP, DNS, MCP_SERVER)

​
serviceId
string<uuid> | null

Service catalog UUID to test against (status data events)

​
componentName
string | null

Component name to test against (status data events, e.g. "Actions")

​
resourceGroupIds
(string<uuid> | null)[] | null

Resource group UUIDs the entity belongs to, for resource_group_id_in rules

Resource group UUIDs the entity belongs to, for resource_group_id_in rules

Response

200 - */*

OK

​
data
object

Result of a dry-run match evaluation against a notification policy