Skip to main content
POST
/
api
/
v1
/
monitors
/
{id}
/
pause
Pause a monitor (set enabled=false)
curl --request POST \
  --url https://api.devhelm.io/api/v1/monitors/{id}/pause \
  --header 'Authorization: Bearer <token>'
{
  "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",
    "assertions": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "assertionType": "status_code",
        "config": {
          "type": "<string>",
          "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": "<string>",
      "headerName": "<string>",
      "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"
    ]
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Response

200 - */*

OK

data
object

Full monitor representation