REST API

#Base URL

All API requests go to the UpCheck backend over HTTPS:

https://upcheck-api-a.rekwiem.com

#Authentication

The API authenticates with project API keys: revocable tokens that start with upk_. A key is scoped to exactly one project, so it can read and write that project's monitors and nothing else. Account level endpoints reject API keys.

#Create an API key

In the dashboard, open your project's Settings and find Access tokens. Name the token, optionally give it an expiry, and generate it. The full key is shown once, at creation, so copy it somewhere safe. You can revoke any key from the same list.

#Use the key

Send it as a Bearer token on every request:

Authorization: Bearer upk_your_key

#Endpoints

Every endpoint, with its parameters and response schema, is listed in the API reference. That page is generated from the API's own OpenAPI document, so it always matches the deployed backend.

#Example: create a monitor

Only url is required. This creates an HTTP monitor on a 5 minute interval:

curl -X POST https://upcheck-api-a.rekwiem.com/v1/monitors \
  -H "Authorization: Bearer upk_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com", "interval_sec": 300 }'

The response is the created monitor, including the result of its first check.

#Generate a client

The OpenAPI document is served straight from the API, so you can point any generator or HTTP client at it:

https://upcheck-api-a.rekwiem.com/openapi.json