The Uptimia API v2 Endpoint Map

Everything you can do in the control panel has a route under /api/v2/. The groups below give each resource's base path, its extra actions and the paths whose names differ from the label on screen, and each group links to the hosted reference, which carries the parameter-by-parameter detail. If you have not made a first call yet, start with Getting Started with the Uptimia API.

Before You Start

• An API key, created at Settings → API Keys. Only the Owner and Admin roles can open that tab.
• The base URL for your account. For accounts on www.uptimia.com it is https://www.uptimia.com; the API Documentation card inside a key's editor shows yours.
• Every request carries Authorization: Bearer <your key>. Requests are JSON in and JSON out.
• Keys carry the role and monitor-group scope of the seat that minted them. POST /api/v2/auth/token mints one from credentials. 401 and 403 arrive in two different envelopes. Getting Started with the Uptimia API covers all three.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://www.uptimia.com/api/v2/uptime

Where the Full Reference Lives

The v2 reference is at https://www.uptimia.com/developers. It renders the live /api/v2/openapi.json spec with Redoc: 188 paths and 277 operations, grouped in a sidebar by resource. https://www.uptimia.com/api redirects to https://developers.uptimia.com/api, and the View API Documentation link on a key's editor page points at https://developers.uptimia.com, so both land on the older site, which still publishes the v1 (legacy) reference.

The spec behind it is also served raw, and the older site is still online:

Two URLs that older documentation pointed at no longer resolve. https://www.uptimia.com/api/v2/ returns 404, because the version prefix has no index page, and /api/v2/keys returns 404 as well, because API keys live at /api/v2/api-keys.

Monitor Paths by Family

Each monitor family is its own resource with its own base path, and that path is not always the word you see in the control panel.

Eleven of the twelve families answer the same five calls: GET the base path to list, POST it to create, then GET, PATCH and DELETE on /{id}. Server is the exception. Its list is GET /api/v2/server/list, and a GET on the bare path answers 405 (see Path Quirks). Four families also accept PUT on /{id} as an alias of PATCH: API, Heartbeat, DNS and Blacklist.

Families also carry their own actions:

Three actions work across families, with the family key in the path: POST /api/v2/monitors/{type}/{id}/pause, /resume and /copy. Bulk creation is POST /api/v2/monitors/bulk, with POST /api/v2/monitors/bulk/preview to dry-run the list first.

Reading History: Logs, Incidents, Timelines and Charts

The first two readers are account-wide; the rest are per-monitor.

Two families are exceptions. Heartbeat's check history is GET /api/v2/heartbeat/{id}/pings, and Server's reader is GET /api/v2/server/{id}/data, the time-series metric samples the agent has sent. Neither family has a /logs route.

File exports live beside the JSON readers, two of them at GET /api/v2/logs/export/csv and GET /api/v2/incidents/export/csv. Per record, they are /export/pdf and /export/html under both /logs/{type}/{id} and /incidents/{type}/{id}, and POST /api/v2/logs/{type}/{id}/public-link and POST /api/v2/incidents/{type}/{id}/public-link mint a no-login share URL. Exporting Your Data covers the formats and what each one contains.

Your plan's readable window sets how far back a range can reach. On Uptime, Speed and Virus, a date_start earlier than that floor is silently raised to it rather than refused. Omitting the range does not get you everything either. GET /api/v2/uptime/logs falls back to the floor itself. Every other clamped endpoint falls back to its own default window, one of 24 hours, 7, 14, 30 or 90 days by route, and that default is raised to the floor only if the floor is more recent. The other families pass the range through unchanged, so they answer an older window as asked, as far back as their stored history reaches. See Data and Log Retention.

Publishing: Status Pages, Threads, Updates and Subscribers

Reporting: Scheduled Reports, Sends, Exports and Public Links

GET and POST /api/v2/reports list and create scheduled reports, and GET, PATCH and DELETE /api/v2/reports/{id} handle one. Send one immediately with POST /api/v2/reports/{id}/send. GET /api/v2/reports/{id}/export/{pdf|html|csv} downloads it, POST /api/v2/reports/{id}/public-link renders a shareable page, and POST /api/v2/reports/custom builds and delivers a one-off report without saving a schedule. GET /api/v2/reports/branding-themes lists the themes a report can use.

Maintenance Windows

preview always answers 200, so read data.valid rather than the status code. Automating Maintenance from Your Pipeline covers driving these from a deploy pipeline, including the ordering that avoids a false alert.

Alerting: Contacts, Integrations, Escalation Policies and Alert Groups

Reusable Configuration

Creating a monitor from a template is a client-side merge. Take the template's settings, overlay the new name and address, POST it to that family's create path, then call /{id}/used.

apply returns 200 even when every monitor failed, so read data.results[].ok per entry. If a profile ends up with fewer than 6 probes, every entry fails with too_few_locations and nothing is written.

Account: Users, Roles, Teams and Settings

The hosted reference leaves out the account-management and control-panel-internal groups, so the paths above are the record for those. Server monitors, API keys, the activity log, dashboard, search, bulk creation, subscription, billing, payments and the account-security half of Settings are all live and callable, and none of them appear in the reference sidebar.

Path Quirks That Cause a 404

Pagination differs by endpoint. Monitor lists take limit and offset, GET /api/v2/logs takes page and limit (default 20), and GET /api/v2/monitor-templates takes neither, returning a bare {"data": [...]} with no metadata envelope to read a total from. /api/v2/uptime/logs still exists alongside /api/v2/logs; new code should use the latter.

Rate Limits: What Is Throttled

Uptimia sets no global per-key request quota, and ordinary monitor reads and writes are not counted against one. Seven named actions carry their own limits. The first five each start real work; the last two are credential actions:

Uptimia writes check results on the monitor's own schedule, so polling a log endpoint faster than the monitor checks returns the same rows.

Telling a 404 Apart From a 405

Uptimia renders routing-level 404s and 405s as HTML error pages, because the request never reaches a controller. A 404 raised inside a controller, for a record that is not yours, comes back as ordinary JSON. A client that calls response.json() unconditionally will throw on a typo in a path, so branch on the status code first.

Probing a path from the terminal tells you which you hit:

curl -s -o /dev/null -w '%{http_code}\n' https://www.uptimia.com/api/v2/api-keys

401 means the route exists and needs authentication, 404 means it does not exist, and 405 means it exists with a different method. Error envelopes for 401, 403 and 400 are in Getting Started with the Uptimia API.

Related Articles

• Getting Started with the Uptimia API
• Automating Maintenance from Your Pipeline
• Read-Only and Group-Limited API Keys
• Exporting Your Data
• Webhook Payload Reference