API and automation · Help

Manage monitors from code, mark deploys and read your status programmatically.

REST API

Create an API key under Settings → API & automation and send it as Authorization: Bearer cu_…. The API reference lists every endpoint with examples.

curl -H "Authorization: Bearer cu_…" https://your-uplance/api/v1/monitors

Monitors as code

Keep your monitors in a uplance.yaml file in your repository and sync it from CI. GET /api/v1/sync exports what you have; POST with ?dryRun=1 shows what would change, without it applies the changes, and &prune=1 also deletes monitors that aren't in the file.

Deploy markers

Tell Uplance when you deploy:

curl -X POST -H "Authorization: Bearer cu_…" -H "Content-Type: application/json" \
  -d '{"version":"v1.2.3","author":"ci","muteMinutes":10}' https://your-uplance/api/v1/deploys

Deploys appear on charts, are named in down alerts, and muteMinutes holds alerts during the rollout.

Public status JSON

GET /api/v1/status/your-workspace returns the overall state, public monitors and open incidents. It needs no key and allows cross-origin requests, so you can show it on your own website.

Heartbeats

Heartbeat monitors have a URL of their own. Call it at the end of a job: curl https://your-uplance/api/push/<token>. Add ?status=down&msg=… to report a failure, or ?ping=123 to chart how long the job took.