Update a heartbeat (cron) monitor.

PUT

/cron/job/{cron_job_id}

const url = 'https://api.siteqwality.com/cron/job/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"friendly_name":"example","check_interval_seconds":1,"grace_seconds":1,"group_notification_ids":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"state":"active","tags":["example"],"service_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'
};

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

curl --request PUT \
  --url https://api.siteqwality.com/cron/job/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "friendly_name": "example", "check_interval_seconds": 1, "grace_seconds": 1, "group_notification_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "state": "active", "tags": [ "example" ], "service_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

bearer_auth

Parameters

Path Parameters

cron_job_id

required

string format: uuid

Heartbeat monitor identifier

Request Body^required

application/json

object

friendly_name

string | null

check_interval_seconds

integer | null format: int32

grace_seconds

Extra seconds, 0 to 86400, after the interval before a missing ping alerts.

integer | null format: int32

group_notification_ids

array | null

state

One of:

string
null

string

Allowed values: active paused

tags

array | null

service_id

The service this monitor belongs to; null detaches it and omission keeps it.

string | null format: uuid

Responses

200

Heartbeat monitor updated

400

Invalid request body

401

Missing or invalid authentication

402

Heartbeat or account monitor limit reached (reactivating a paused monitor)

404

Heartbeat monitor not found

500

Internal server error