A small request. A useful connection.
The REST API lets you work with your Uptiva monitors from scripts and other tools. Requests use a workspace API key and return JSON.
https://uptiva.linuxmaster.cloud/apiAuthentication
Create an API key from Integration & API in your workspace. Send it in the Authorization header as a bearer token. Keys begin with upk_ and can have a read or write scope.
Authorization: Bearer upk_your_keyRead-only keys can call GET endpoints. Use a write key only when your integration needs to make changes. API access and key limits depend on your plan.
Your first request
Set UPTIVA_API_KEY in your local environment, then list the monitors your key can access. The example is for your terminal or a server-side script; keep keys out of public browser code.
curl https://uptiva.linuxmaster.cloud/api/monitors \
-H "Authorization: Bearer $UPTIVA_API_KEY"const response = await fetch(
"https://uptiva.linuxmaster.cloud/api/monitors",
{ headers: { Authorization: `Bearer ${process.env.UPTIVA_API_KEY}` } }
);
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const monitors = await response.json();Reading the response
The monitor list is a JSON array. Each entry includes its name, type, target and current state. Here is an abbreviated, illustrative response; the full object contains additional fields.
[
{
"id": "77d25f86-a579-408a-a016-9ca98b32f536",
"name": "Public API",
"type": "http",
"target": "https://api.example.com/health",
"status": "Operational",
"paused": false,
"response_ms": 86
}
]A few useful endpoints
Paths below are relative to the base URL. See the interactive reference for parameters and complete response schemas.
Limits and errors
API requests are limited to 120 per minute per key. Avoid tight polling loops and handle non-success responses before reading data.
| Response | What to check |
|---|---|
401 Unauthorized | Check that the bearer key is present and valid. |
403 Forbidden | Review the key scope and your plan’s API access. |
404 Not found | Check the resource ID and whether it is available to your key. |
429 Too many requests | Reduce request frequency and retry later. |
Go a little deeper.
The interactive API reference is the source for request schemas and the complete supported endpoint list. Logs use a separate log token, rather than a workspace API key.