Supercheck LogoSupercheck
Monitors API

Create a monitor

Create a new uptime or performance monitor.

POST
/api/monitors

Authorization

bearerAuth
AuthorizationBearer <token>

CLI token (sck_live_*) for full API access, or trigger key (sck_trigger_* / legacy job_*) for job trigger endpoint only.

In: header

Request Body

application/json

name*string
target*string

URL or host to monitor

Formaturi
type?string
Default"http_request"
Value in"http_request" | "website" | "ping_host" | "port_check" | "synthetic_test"
frequencyMinutes?integer

Check interval in minutes

Default5
timeout?integer

Request timeout in seconds

Default30
method?string
Default"GET"
Value in"GET" | "POST" | "HEAD" | "PUT" | "PATCH" | "DELETE"

Response Body

application/json

application/json

curl -X POST "https://demo.supercheck.dev/api/monitors" \  -H "Content-Type: application/json" \  -d '{    "name": "API Health Check",    "target": "https://api.example.com/health"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "target": "http://example.com",
  "type": "http_request",
  "status": "up",
  "frequencyMinutes": 0,
  "timeout": 0,
  "method": "string",
  "active": true,
  "lastCheckAt": "2019-08-24T14:15:22Z",
  "responseTime": 0,
  "createdAt": "2019-08-24T14:15:22Z"
}
{
  "error": "Unauthorized"
}