ReferenceAPI
Monitors
HTTP monitors, their settings and their latest results.
curl -X GET "https://example.com/v1/monitors"{ "monitors": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "componentId": "616ccd92-d666-4180-8349-8d125b269fac", "name": "string", "type": "http", "http": { "url": "http://example.com", "method": "GET", "expectedStatus": [ 100 ], "keyword": "string", "timeoutMs": 10000, "followRedirects": true }, "publishPolicy": "auto", "downStatus": "partial_outage", "detection": {}, "enabled": true } ]}POST
/v1/monitorsRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/monitors" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "http": { "url": "http://example.com" } }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "componentId": "616ccd92-d666-4180-8349-8d125b269fac", "name": "string", "type": "http", "http": { "url": "http://example.com", "method": "GET", "expectedStatus": [ 100 ], "keyword": "string", "timeoutMs": 10000, "followRedirects": true }, "publishPolicy": "auto", "downStatus": "partial_outage", "detection": {}, "enabled": true}GET
/v1/monitors/telemetryReads telemetry only; poll it while the monitors page is open.
Response Body
application/json
curl -X GET "https://example.com/v1/monitors/telemetry"{ "regions": [ "string" ], "monitors": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "state": "unknown", "status": "operational", "since": "2019-08-24T14:15:22Z", "results": [ { "region": "string", "scheduledAt": "2019-08-24T14:15:22Z", "status": "up", "latencyMs": 0 } ] } ]}curl -X DELETE "https://example.com/v1/monitors/497f6eca-6276-4993-bfeb-53cbbbba6f08"Empty
PUT
/v1/monitors/{id}Send every field; omitted optional fields fall back to their defaults.
Path Parameters
id*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PUT "https://example.com/v1/monitors/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "http": { "url": "http://example.com" } }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "componentId": "616ccd92-d666-4180-8349-8d125b269fac", "name": "string", "type": "http", "http": { "url": "http://example.com", "method": "GET", "expectedStatus": [ 100 ], "keyword": "string", "timeoutMs": 10000, "followRedirects": true }, "publishPolicy": "auto", "downStatus": "partial_outage", "detection": {}, "enabled": true}