Supercheck LogoSupercheck
Monitors API

Update monitor status

Pause, resume, or otherwise set a monitor's status (up, down, paused or pending; maintenance and error are not accepted). Requires monitor manage or update permission. Automated status changes from checks are handled separately. Read current monitor status with GET /api/monitors/{id}; this route does not support GET.

PATCH
/api/monitors/{id}/status

Authorization

bearerAuth
headerAuthorizationBearer <token>

Project-scoped CLI token (sck_live_* or sck_test_*) for documented API operations that accept bearer authentication. Interactive browser operations may require a session cookie. Trigger keys (sck_trigger_* / legacy job_*) are accepted only by job trigger endpoints.

Path Parameters

id*string

Monitor ID

Formatuuid

Request Body

application/json
  1. body
status*string
Value in"up""down""paused""pending"

Response Body

Monitor status updated

application/json
  1. response
success?boolean
id?string
Formatuuid
status?string
Value in"up""down""paused""pending"
updatedAt?string
Formatdate-time
Example Request
curl -X PATCH 'https://demo.supercheck.dev/api/monitors/497f6eca-6276-4993-bfeb-53cbbbba6f08/status' \  -H 'Content-Type: application/json' \  -d '{  "status": "up"}'
Example Response
{  "success": true,  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "up",  "updatedAt": "2019-08-24T14:15:22Z"}