API Reference
Use APIContext's REST API to manage monitors, schedules, workflows, results, analytics, and more. The full generated reference covers both API v2 and API v3, and operation pages offer a browser-based Send API Request panel.
Start here
- Make your first API call with a read-only operation and a disposable test credential.
- Browse API v3 monitors and legacy v2 calls.
- Inspect v3 schedules and v2 schedules in the complete contract; the curated v2 view is also retained.
- Use APIContext with a coding agent.
Authentication
Send an API key in the Authorization header as Bearer <your API key>. Generate one from Settings → API Key Access in the APIContext dashboard; see Using the APIContext API. The complete reference also lists OAuth2 and an X-Api-Key header. The in-browser Send API Request panel accepts only the Authorization header.
Use only test credentials in the in-browser panel. It works on docs.apicontext.com only: see Make your first API call.
API versions
| Version | API origin | Coverage |
|---|---|---|
| v2 | https://client.apimetrics.io/api/2 | Existing calls, schedules, workflows, and other legacy operations |
| v3 | https://client.apimetrics.io/api/3 | Monitors, schedules, organizations, analytics, and more |
| OAuth token endpoint | https://apimetrics.auth0.com | Separately documented token flow |
The complete reference contains all the approved v2 and v3 paths in one contract. The settings API reference and curated v3 reference are retained for compatibility; neither is the complete API catalog.
Download OpenAPI
- Complete v2 + v3 OpenAPI JSON: the primary integration contract.
- Curated settings API JSON.
- Curated v3 API JSON.
- OAuth token endpoint JSON.
Use the first-call guide for the interactive request flow and pagination for collection responses.