Skip to Content
API ReferenceList Checks

List Checks

Retrieve a list of all monitoring checks in your account.

Endpoint

GET /v1/public/checks

Query Parameters

ParameterTypeDefaultDescription
limitinteger25Number of results per page (1-100)
pageinteger1Page number for offset pagination
cursorstring-Cursor for cursor-based pagination
statusstring-Filter by status: up, down, paused
includeTotalbooleanfalseInclude total count in response

Pagination

The API supports two pagination methods:

Offset Pagination

Use page and limit parameters:

curl -H "X-Api-Key: ek_live_..." \ "https://us-central1-exit1-dev.cloudfunctions.net/publicApi/v1/public/checks?page=2&limit=10"

Cursor Pagination

Use the cursor value from the previous response for more efficient pagination:

curl -H "X-Api-Key: ek_live_..." \ "https://us-central1-exit1-dev.cloudfunctions.net/publicApi/v1/public/checks?cursor=abc123&limit=10"

Response

{ "data": [ { "id": "abc123", "name": "Production Website", "url": "https://example.com", "type": "website", "method": "GET", "status": "up", "interval": 120, "region": "us-central", "expectedStatus": 200, "lastChecked": "2025-01-15T14:30:00Z", "lastResponseTime": 245, "uptime": 99.95, "ssl": { "valid": true, "issuer": "Let's Encrypt", "expiresAt": "2025-04-15T00:00:00Z" }, "createdAt": "2024-06-01T10:00:00Z" } ], "meta": { "page": 1, "limit": 25, "total": 12, "cursor": "next_cursor_value" } }

Code Examples

cURL

curl -H "X-Api-Key: ek_live_your_key_here" \ "https://us-central1-exit1-dev.cloudfunctions.net/publicApi/v1/public/checks?limit=10&status=up"

JavaScript

const response = await fetch( "https://us-central1-exit1-dev.cloudfunctions.net/publicApi/v1/public/checks?limit=10", { headers: { "X-Api-Key": "ek_live_your_key_here", }, } ); const data = await response.json(); console.log(data);

Python

import requests response = requests.get( "https://us-central1-exit1-dev.cloudfunctions.net/publicApi/v1/public/checks", headers={"X-Api-Key": "ek_live_your_key_here"}, params={"limit": 10} ) data = response.json() print(data)
Last updated on