Skip to content
You Up? Docs

The You Up? API

The You Up? API lets your own code do what you do in the dashboard: create, change, pause and delete Monitors, read their results, uptime and Incidents, acknowledge or resolve an Incident, and manage Notification rules and Webhooks. It follows the dashboard’s rules, and refuses what the dashboard would refuse.

It answers at https://api.uup.dev/v1, and every Plan has it, with the same limits.

What stays in the dashboard

Section titled “What stays in the dashboard”
  • The Status page. Set it up and change it in the dashboard.
  • Channels. The API lists a Project’s Channels, so a Notification rule can name them, but adding or changing a Channel is done in the dashboard.
  • Your Organization, its Members and its Plan. No token can change them, make or delete a Project, or make another token.
  • Your own Recap. Turn it on or off in Account settings.

Your first call

Section titled “Your first call”

Your code sends an API token in the Authorization header. This lists the Projects the token reaches:

Terminal window
curl -H "Authorization: Bearer uup_api_…" https://api.uup.dev/v1/projects

The API is for code on a server. A web page cannot call it, so a token never ends up where your visitors can read it.

Your first API call goes on from here, in curl, JavaScript and Python.

What is not ok now

Section titled “What is not ok now”

GET /status answers, in one request, what is not ok now in every Project the token reaches: the Monitors whose status is not ok, the open Incidents and since when, and the open Regional outages. Add ?project= with a Project’s id for that Project alone.

Terminal window
curl -H "Authorization: Bearer $UUP_API_TOKEN" \
  "https://api.uup.dev/v1/status"

Read on

Section titled “Read on”