Uptimely

Update a monitor

PATCH
/v1/monitors/{monitor_id}

Changes one or more of a monitor's editable fields through the same domain path as the dashboard's own edit forms. Every field is optional; omitted fields are left untouched, and description accepts null to clear it. url applies to Website/API/External Status Page monitors and host to Ping/IP/Port/DNS/SSL Certificate/Domain monitors — the one the monitor's type does not use is refused rather than silently ignored. request_timeout_seconds is a Website/API setting (null restores the 30-second default), and failure_threshold is refused for Manual, Incoming Request and Incoming Email monitors. heartbeat_interval_minutes and heartbeat_grace_minutes set the dead-man's-switch schedule of an Incoming Request monitor — how long silence may last before it is declared down — and are refused for every other type. At least one field must be present.

Authorization

bearerAuth
AuthorizationBearer <token>

An uptimely_live_ project API key (Settings → API Keys).

In: header

Path Parameters

monitor_id*string

Monitor id.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

At least one field is required — an empty object is refused.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/v1/monitors/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "description": "string",  "monitor_type": "string",  "status": {    "name": "string",    "color": "string"  },  "active_monitoring_disabled": true,  "failure_threshold": -9007199254740991,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}