Home › Install guides › API reference
Install guide · Developers and MSPsAPI reference
Every management API call, from the OpenAPI description the server publishes.
Uplivra Technologies LLC · Guide for Uplivra 26.10 · Updated 4 October 2026 · Latest version: https://uplivra.com/guides/api-reference.html
Every call of the management API, made from the OpenAPI description your server publishes at https://<your server>/api/v1/openapi.json (no token needed). Paths are relative to /api/v1. How to turn the API on, tokens and limits: The Uplivra API.
| Method | Path | What it does |
|---|---|---|
| GET | /access-groups | Access groups (read only) |
| GET | /access-profiles | Access profiles and their permissions (read only) |
| GET | /alerts | Alerts, newest first |
| POST | /alerts/{id}/ack | Acknowledge an open alert (stops escalation) |
| GET | /audit | The audit log, newest first |
| GET | /channels | Where alerts go (secrets and webhook addresses are hidden) |
| POST | /channels | Add a place to send alerts |
| DELETE | /channels/{id} | Remove a place to send alerts |
| POST | /channels/{id}/test | Send a test message now |
| GET | /checks/{id} | One check |
| PATCH | /checks/{id} | Change a check: interval, timeout, alert_after, enabled (pause or resume) or its whole config |
| DELETE | /checks/{id} | Delete a check (needs delete) |
| GET | /checks/{id}/results | A check's results, newest first |
| GET | /collectors | List collectors |
| GET | /collectors/{id} | One collector |
| GET | /configs/{id} | One saved configuration, with its text (recorded in the audit log) |
| GET | /configs/{id}/diff | What changed: a unified diff against the version before (or ?against=) |
| GET | /devices | List devices with their status and checks |
| POST | /devices | Add a device |
| POST | /devices/import | Import or update many devices at once (the CSV import's fields, as JSON) |
| GET | /devices/{id} | One device with its status and checks |
| PATCH | /devices/{id} | Change a device (only the fields given) |
| DELETE | /devices/{id} | Delete a device and its checks and history (needs delete) |
| GET | /devices/{id}/checks | A device's checks |
| POST | /devices/{id}/checks | Add a check to a device |
| GET | /devices/{id}/configs | A device's saved configuration versions, newest first |
| PUT | /devices/{id}/parent | Set what a device sits behind (alerts behind a down parent are held back) |
| GET | /discovery/scans | Discovery scans |
| POST | /discovery/scans | Create a discovery scan (run it with /discovery/scans/{id}/run) |
| GET | /discovery/scans/{id} | One discovery scan and its progress |
| POST | /discovery/scans/{id}/run | Run a discovery scan now |
| GET | /groups | Ownership groups (who looks after devices) |
| GET | /ipam/reservations | Reserved IP addresses |
| POST | /ipam/reservations | Reserve an address, or change its reservation |
| DELETE | /ipam/reservations/{ip} | Remove a reservation (needs delete) |
| GET | /ipam/subnets | Subnets (IP address management) |
| POST | /ipam/subnets | Add a subnet (Network Pro) |
| GET | /ipam/subnets/{id} | One subnet |
| PATCH | /ipam/subnets/{id} | Change a subnet (only the fields given) |
| DELETE | /ipam/subnets/{id} | Remove a subnet (needs delete; addresses and reservations stay) |
| GET | /ipam/vlans | VLANs |
| POST | /ipam/vlans | Add a VLAN |
| DELETE | /ipam/vlans/{id} | Remove a VLAN from the list (needs delete) |
| GET | /license/usage | Devices counted against the plan |
| GET | /logs | Search logs and SNMP traps, newest first |
| GET | /maintenance | Maintenance windows |
| POST | /maintenance | Start or plan a maintenance window |
| POST | /maintenance/decision | Approve or reject a waiting maintenance window |
| DELETE | /maintenance/{id} | End a maintenance window now |
| GET | /me | This token: its access level, permissions, sites and limits |
| GET | /runbook-runs | Recent runbook runs |
| GET | /runbook-runs/{id} | One run with its log |
| GET | /runbooks | Runbooks (Automation) |
| GET | /runbooks/{id} | One runbook with its steps |
| POST | /runbooks/{id}/run | Run a runbook (or a dry run) |
| GET | /sites | List sites |
| POST | /sites | Create a site |
| GET | /sites/{id} | One site |
| PATCH | /sites/{id} | Rename a site |
| POST | /sites/{id}/enrollment-tokens | Create a one-time collector enrollment token (valid 24 hours) |
| GET | /status | Every device's status and checks (not paged; prefer /devices) |
| GET | /tags | Every device tag in use |
| GET | /tickets | Service desk tickets |
| POST | /tickets | Open a ticket |
| GET | /tickets/{number} | One ticket with its comments |
| POST | /tickets/{number}/comments | Add a comment (public) or an internal note |
| GET | /users | People (read only) |
| GET | /version | This server's version, API version, server_id, tenant_id and features (read., write.) (check before anything else) |
| GET | /vulnerabilities | Possible vulnerabilities (CVEs) found on devices |