API Reference
The API Reference contains endpoints, parameters and response examples for VPC systems.
The production VPC API is available at https://api.ucp.li and requires an API key.
Append the paths in the tables directly to this base URL. Do not add an extra /api.
Available APIs
VPC API Overview
The interactive VPC API Reference contains the full details, response examples and schemas.
Vehicles
| Method | Path | Description |
|---|---|---|
GET | /vehicles | List vehicles for the API key's network with pagination |
POST | /vehicles | Create a vehicle in the API key's network |
GET | /vehicles/{vehicle} | Show a single vehicle |
PUT | /vehicles/{vehicle} | Update vehicle data |
PATCH | /vehicles/{vehicle} | Update individual vehicle fields |
DELETE | /vehicles/{vehicle} | Delete a vehicle |
Statistics
| Method | Path | Description |
|---|---|---|
GET | /statistics/active-users | List officers who are currently on duty and when their dutytime started |
GET | /statistics/missions/last-7-days | Count mission reports from the last seven days |
GET | /statistics/missions/total | Count all mission reports |
GET | /statistics/files/last-7-days | Count patient and offender files from the last seven days |
GET | /statistics/files/total | Count all patient and offender files |
For all statistics endpoints:
- Values are limited to the network that belongs to the API key.
- The two seven-day endpoints count records whose
created_atvalue is at or after the point seven days before the request. Records without a known creation time are excluded even whentimestampAvailableistrue. - If the system cannot evaluate creation times, the affected seven-day endpoint returns
count: nullandtimestampAvailable: false. Do not interpretnullas0. The matching/totalendpoint remains available and also counts records without a known creation time. Contact support if you need the time-based statistic.