API Reference

The supported public Supercheck API provides programmatic access to jobs, tests, monitors, variables, notifications, and other documented resources. The web dashboard also uses internal and streaming routes that are intentionally outside this public API contract.

Base URL

Authentication

Resource-management requests require authentication via an Authorization: Bearer <token> header. Explicitly public endpoints, such as health checks and published status-page feeds, do not. See Authentication for details on token types.

curl https://app.supercheck.io/api/jobs \
  -H "Authorization: Bearer sck_live_..."

Interactive API Reference

Browse the full interactive API documentation with request/response examples, code samples, and a built-in playground to test endpoints directly.

OpenAPI Specification

The OpenAPI 3.1 specification for the supported public API is available for SDK generation and tooling:

SDK Generation

# TypeScript types
npx openapi-typescript https://supercheck.io/openapi/openapi.json -o ./types/supercheck-api.d.ts

# TypeScript client
npx openapi-typescript-codegen \
  --input https://supercheck.io/openapi/openapi.json \
  --output ./sdk

# Python
openapi-generator generate \
  -i https://supercheck.io/openapi/openapi.json \
  -g python -o ./supercheck-sdk-python

# Go
openapi-generator generate \
  -i https://supercheck.io/openapi/openapi.json \
  -g go -o ./supercheck-sdk-go

Response Format

Responses are JSON. Pagination shapes are endpoint-specific; for example, resource-list endpoints commonly return:

{
  "data": [],
  "pagination": {
    "total": 0,
    "page": 1,
    "limit": 50,
    "totalPages": 0,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

Rate Limits

Rate-limit headers are included on rate-limited responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1612137600
Retry-After: 60  # Only on 429 responses

Reference Guides

• Authentication — Token types, security, and rate limiting
• Errors — Error codes, formats, and retry behavior