API key

You need a network before you can create an API key. You can create the API key when creating a network or generate it later in the network overview.

Create API key

Open the network overview in the UCP, edit the matching network and generate the API key.

Change API key

If you need a new key, open the same network settings again and regenerate the key.

Use the API

The production API is available at:

https://api.ucp.li/v2

Send your API key with every request in the X-API-Key header. Alternatively, you can send the same key as a Bearer token.

X-API-Key: <your-api-key>
Accept: application/json

The API always operates inside the network that belongs to the API key. Do not send the network field in request bodies.

Vehicle Endpoints

Method	Path	Description
GET	/vehicles	List vehicles with pagination
POST	/vehicles	Create a vehicle
GET	/vehicles/{vehicle}	Show a vehicle
PUT	/vehicles/{vehicle}	Update a vehicle
PATCH	/vehicles/{vehicle}	Update individual vehicle fields
DELETE	/vehicles/{vehicle}	Delete a vehicle

The internal /fivem endpoints are not part of this public API documentation.

List Vehicles

GET /vehicles supports these optional query parameters:

Parameter	Description
search	Search by plate, vehicle, owner, color or wanted reason
sort_field or sortField	Sort field: plate, car, owner, tuv or wanted
sort_order or sortOrder	Sort order: asc or desc
per_page or perPage	Results per page, default is 15

Example:

GET https://api.ucp.li/v2/vehicles?search=AB-1234&sort_field=plate&sort_order=asc&per_page=15
X-API-Key: <your-api-key>
Accept: application/json

Create Vehicle

For POST /vehicles, plate is required. All other fields are optional.

{
  "plate": "AB-1234",
  "cartyp": "Benefactor",
  "car": "Luxe",
  "owner": "John Doe",
  "tuv": "2028-01-01",
  "comment": "Vehicle should be checked for illegal modifications",
  "color": "Midnight Silver",
  "wanted": false,
  "wanted_reason": null,
  "synced": true,
  "sync_id": "ext-123"
}

PUT and PATCH accept the same fields, but all fields are optional for updates.

Some response field names differ from request field names:

Request field	Response field
cartyp	carType
tuv	generalInspection
wanted_reason	wantedReason
sync_id	syncId

Open the interactive VPC API v2 Reference for schemas, response examples and additional details.