API Reference
Supercheck REST API documentationEdit
The Supercheck API provides programmatic access to all platform features — jobs, tests, monitors, variables, notifications, and more. The API is used by the CLI, the web dashboard, and can be integrated directly into your own tools.
Base URL
| Environment | URL |
|---|---|
| Cloud | https://demo.supercheck.dev |
| Self-Hosted | Your deployment URL (e.g. https://supercheck.yourdomain.com) |
Authentication
All API requests require authentication via Authorization: Bearer <token> header. See Authentication for details on token types.
curl https://demo.supercheck.dev/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.
Authentication
CLI token management — create, list, update, and revoke tokens
Jobs
Job scheduling, execution, and triggering
Trigger Keys
Manage trigger keys for CI/CD job execution
Runs
Job run management, status tracking, and live streaming
Tests
Test script CRUD operations
Monitors
Uptime monitor management, check results, and statistics
Variables
Project environment variables and secrets
Notifications
Notification providers — Slack, email, webhooks, and more
Tags
Tag management for organizing tests and resources
Status Pages
Public status page management and RSS feeds
Alerts
Alert history and notification tracking
Audit
Organization audit logs
System
Health check and available execution locations
OpenAPI Specification
The full OpenAPI 3.1 specification is available for SDK generation and tooling:
| Format | URL |
|---|---|
| JSON | /openapi/openapi.json |
| YAML | /openapi/openapi.yaml |
SDK Generation
# TypeScript types
npx openapi-typescript https://demo.supercheck.dev/openapi.json -o ./types/supercheck-api.d.ts
# TypeScript client
npx openapi-typescript-codegen \
--input https://demo.supercheck.dev/openapi.json \
--output ./sdk
# Python
openapi-generator generate \
-i https://demo.supercheck.dev/openapi.json \
-g python -o ./supercheck-sdk-python
# Go
openapi-generator generate \
-i https://demo.supercheck.dev/openapi.json \
-g go -o ./supercheck-sdk-goResponse Format
All responses are JSON. Paginated endpoints return:
{
"data": [...],
"pagination": {
"total": 42,
"page": 1,
"limit": 50,
"totalPages": 1,
"hasNextPage": false,
"hasPrevPage": false
}
}Rate Limits
| Token Type | Limit | Window |
|---|---|---|
CLI Token (sck_live_*) | 1000 req/min | Per user |
Trigger Key (sck_trigger_*) | 60 req/min | Per key |
| Unauthenticated | 10 req/min | Per IP |
Rate limit headers are included in every response:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1612137600
Retry-After: 60 # Only on 429 responsesReference Guides
- Authentication — Token types, security, and rate limiting
- Errors — Error codes, formats, and retry behavior