Skip to main content
GET
/
api
/
v1
/
monitors
List monitors for the authenticated org
curl --request GET \
  --url https://api.devhelm.io/api/v1/monitors \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": 123,
      "name": "<string>",
      "config": {
        "hostname": "<string>",
        "recordTypes": [],
        "nameservers": [
          "<string>"
        ],
        "timeoutMs": 123,
        "totalTimeoutMs": 123
      },
      "frequencySeconds": 123,
      "enabled": true,
      "regions": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "assertions": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "config": {
            "substring": "<string>"
          }
        }
      ],
      "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": {
        "vaultSecretId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "incidentPolicy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "triggerRules": [
          {
            "count": 123,
            "windowMinutes": 123,
            "thresholdMs": 123
          }
        ],
        "confirmation": {
          "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"
      ]
    }
  ],
  "hasNext": true,
  "hasPrev": true,
  "totalElements": 123,
  "totalPages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.devhelm.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Query Parameters

enabled
boolean

Filter by enabled state (true/false)

status
string

Lifecycle status alias: 'active' (enabled=true) or 'paused' (enabled=false). Ignored when ?enabled is also supplied.

type
enum<string>

Filter by monitor type

Available options:
HTTP,
DNS,
MCP_SERVER,
TCP,
ICMP,
HEARTBEAT
managedBy
enum<string>

Filter by managed-by source

Available options:
DASHBOARD,
CLI,
TERRAFORM,
MCP,
API
tags
string

Filter by tag names, comma-separated (e.g. prod,critical); OR semantics

tag
string

Filter by a single tag name (alias for ?tags=); merged with ?tags using OR semantics

Case-insensitive name search

environmentId
string<uuid>

Filter by environment ID

pageable
object
required

Response

OK

data
object[]
required
hasNext
boolean
required
hasPrev
boolean
required
totalElements
integer<int64> | null
totalPages
integer<int32> | null