API Reference
API Reference
Query projects, vendors and incidents from your scripts or backend. Base URL:
https://checkupstream.com/api/v1Authentication
Create an API Token in Settings → Credentials → API Tokens. Organization endpoints accept this token (prefix
cup_api_) in the Bearer header shown below. SDK Keys (cup_sdk_) are for telemetry and receive a 403 here.Shell
Authorization: Bearer $CHECKUPSTREAM_API_TOKENThe telemetry endpoint uses an sdk_key field in the request body instead of the Authorization header. Public badge endpoints require no credential. Check the authentication label on each endpoint.
Errors
Use the HTTP status and response body to handle failures. This is an example error; check the endpoint for its response schema.
JSON
{ "error": "Human-readable error message" }Endpoints
Projects
1 endpointManage monitored projects and their parsed dependencies
Services
3 endpointsQuery recorded vendor status and dependency relationships
Incidents
2 endpointsTrack active and resolved upstream incidents
Deploy Gate
1 endpointCheck recorded vendor status before a deployment
Badge
1 endpointEmbeddable SVG status badges for README files and dashboards
Telemetry
1 endpointIngest SDK telemetry from your application runtime. Uses sdk_key body authentication instead of Bearer token.
Create an API token
Choose the minimum permissions your integration needs.