/monitors/{id}/pause

POST

const url = 'https://culipulse.dev/v1/monitors/mon_123/pause';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://culipulse.dev/v1/monitors/mon_123/pause \
  --header 'Authorization: Bearer <token>'

Stop checking the monitor and stop its alerts. Open incidents are closed. Pausing a paused monitor changes nothing.

Authorizations

bearerAuth
write

Parameters

Path Parameters

required

string

Example

mon_123

Responses

200

The paused monitor

application/json

object

required

string

name

required

string

type

required

string

Allowed values: http tcp icmp udp domain heartbeat dns vendor

target

required

string

interval_seconds

required

integer

timeout_ms

required

integer

method

required

string | null

expected_status

required

string | null

body_match

required

string | null

follow_redirects

required

1 = follow redirects, 0 = don’t

integer

down_after_failures

required

integer

up_after_successes

required

integer

down_min_sources

required

How many agents must see a failure before the monitor is marked down. Only used by monitors that check from agents (http, tcp, icmp, udp); vendor, domain and dns are checked once by CuliPulse, so it is always 1 for them.

integer

heartbeat_grace_seconds

required

Heartbeat only. Written as grace_seconds.

integer | null

sla_target

required

number | null

status

required

string

Allowed values: up down degraded paused pending

enabled

required

1 = being checked, 0 = paused. Change it with POST /monitors/{id}/pause and /monitors/{id}/resume.

integer

created_at

required

Unix seconds

integer

updated_at

required

Unix seconds

integer

check_spec

Returned by GET /monitors/{id}; omitted from the list.

object

request

HTTP monitors: what to send.

object

headers

Plain request headers.

object

key

additional properties

string

secretHeaders

Write-only. Headers stored encrypted; reads return their names in secretHeaderNames. Send {} to clear.

object

key

additional properties

string

preserveSecretHeaders

Write-only. true keeps the stored secret headers.

boolean

secretHeaderNames

Read-only. Names of the stored secret headers.

Array<string>

auth

Reads return type only. Send type alone to keep the stored credentials.

object

type

string

Allowed values: bearer basic

token

string

username

string

password

string

body

Request body.

string

bodySecret

On write, stores body encrypted. On read, true means a secret body is set (it isn’t returned).

boolean

preserveBody

Write-only, with bodySecret: true keeps the stored secret body.

boolean

contentType

string

assertions

HTTP monitors: extra checks on the response.

Array<object>

object

source

string

Allowed values: text_body json_body header response_time cert_expiry

string

value

string

path

Json_body only.

string

name

Header only.

string

transport

UDP monitors: what to send and expect.

object

payload

string

payloadEncoding

string

Allowed values: utf8 hex

expect

string

expectMode

string

Allowed values: contains regex

payloadSecret

On write, stores payload encrypted. On read, true means a secret payload is set.

boolean

preservePayload

Write-only, with payloadSecret: true keeps the stored secret payload.

boolean

domain

Days of warning before a domain or certificate expires.

object

warnDays

integer

ping

ICMP monitors.

object

count

integer

lossDegradedPct

integer

rttDegradedMs

integer

heartbeat

Heartbeat monitors. The token is created by the server and kept on update.

object

token

string

failEnabled

boolean

maxDurationSeconds

integer

dns

DNS monitors.

object

records

Array<object>

object

type

string

mode

string

expected

Array<string>

crossCheck

boolean

vendor

Read-only. Vendor status monitors: set by the server from target.

object

vendorId

string

pageUrl

string

probeUrl

string

components

Array<string>

dependencies

Read-only. Ids of the vendor monitors this monitor depends on.

Array<string>

agent_sources

Agent ids probing this monitor. Returned by GET /monitors/{id}.

Array<string>

Example

{
  "id": "mon_123",
  "type": "http",
  "status": "up",
  "check_spec": {
    "request": {
      "auth": {
        "type": "bearer"
      }
    },
    "assertions": [
      {
        "source": "text_body"
      }
    ],
    "transport": {
      "payloadEncoding": "utf8",
      "expectMode": "contains"
    }
  }
}

401

Unauthorized

application/json

object

error

required

string

request_id

string

Example

{
  "error": "not found",
  "request_id": "req_abc123"
}

404

Not found

application/json

object

error

required

string

request_id

string

Example

{
  "error": "not found",
  "request_id": "req_abc123"
}