API Reference
The API Reference contains endpoints, parameters and response examples for VPC systems.
The production VPC API v2 is available at https://api.ucp.li/v2 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 v2 Overview
The interactive VPC API v2 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 |
Dutytime
| Method | Path | Description |
|---|---|---|
POST | /dutytime/{identifier}/toggle | Start an officer's dutytime or stop open dutytime entries |
POST | /dutytime/{identifier}/stop | Stop an officer's open dutytime entries; repeated calls still succeed |
For dutytime:
- No body payload is required. You may optionally send an empty JSON body (
{}). identifieris the FiveM identifier stored on the officer, including its prefix, for examplelicense:0000000000000000000000000000000000000000.- The type must match the connector configuration. See Understanding identifiers for details.
- Use
/dutytime/{identifier}/stopfor targeted stop calls or retry logic. /dutytime/{identifier}/toggleis for clients that intentionally switch between start and stop.
Example:
curl -X POST \
"https://api.ucp.li/v2/dutytime/license:0000000000000000000000000000000000000000/stop" \
-H "X-API-Key: test-api-key" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}'
The internal /fivem routes are intentionally not documented in the public API reference.
Usage
On each API page you can:
- select endpoints in the left navigation,
- check HTTP methods, paths and parameters,
- inspect response examples and schema information,
- switch between product APIs using the tabs above the reference.
Notes
The API specifications are reference material for integrations. For production credentials, environments or activation, use the agreed support and onboarding channels. To create an API key, see Create API key.