API Reference
The CheckUpstream REST API lets you programmatically query your projects, services, incidents, and impact analysis. All endpoints are served from https://checkupstream.com/api/v1
Authentication
All REST endpoints require a Bearer token. The token must be an API Token (prefix cup_api_) — generated from Settings → Credentials → API Tokens. SDK Keys (cup_sdk_) are publishable credentials for the SDKs and are rejected here with a 403.
Authorization: Bearer a1b2c3d4e5f6...The telemetry endpoint uses an sdk_key field in the request body instead of the Authorization header.
Errors
All error responses follow a consistent JSON format:
{ "error": "Human-readable error message" }Endpoints
Projects
1 endpointManage monitored projects and their parsed dependencies
/projectsServices
3 endpointsQuery upstream service health and current status
/services/services/{id}/services/{id}/impactIncidents
2 endpointsTrack active and resolved upstream incidents
/incidents/incidents/{id}Deploy Gate
1 endpointPre-deployment safety checks — gate CI/CD pipelines on upstream health
/deploy-gateBadge
1 endpointEmbeddable SVG status badges for README files and dashboards
/badge/{orgSlug}Telemetry
1 endpointIngest SDK telemetry from your application runtime. Uses sdk_key body authentication instead of Bearer token.
/v1/events