API Reference

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.

Shell

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:

JSON

{ "error": "Human-readable error message" }

Endpoints.

Projects

1 endpoint

Manage monitored projects and their parsed dependencies

GET/projects

Services

3 endpoints

Query upstream service health and current status

GET/services

GET/services/{id}

GET/services/{id}/impact

Incidents

2 endpoints

Track active and resolved upstream incidents

GET/incidents

GET/incidents/{id}

Deploy Gate

1 endpoint

Pre-deployment safety checks — gate CI/CD pipelines on upstream health

GET/deploy-gate

Badge

1 endpoint

Embeddable SVG status badges for README files and dashboards

GET/badge/{orgSlug}

Telemetry

1 endpoint

Ingest SDK telemetry from your application runtime. Uses sdk_key body authentication instead of Bearer token.

POST/v1/events

Build something.

Generate an API token from your dashboard and start querying your dependency graph, incidents, and SLAs.

Get an API Token Read the SDK Reference