Skip to main content
POST
/
api
/
vehicle
/
saveVehicle
Save vehicle
curl --request POST \
  --url https://api2.rhombussystems.com/api/vehicle/saveVehicle \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data @- <<EOF
{
  "alert": true,
  "createdAtMillis": 1640995200000,
  "description": "Blue Honda Civic",
  "name": "John's Car",
  "thumbnailS3Key": "<string>",
  "trust": true,
  "vehicleLicensePlate": "ABC123"
}
EOF
{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for saving a vehicle with license plate information.

​
alert
boolean | null

Whether to alert when this vehicle is detected

​
createdAtMillis
integer<int64> | null

Creation timestamp in milliseconds

Example:

1640995200000

​
description
string | null

Description of the vehicle

Example:

"Blue Honda Civic"

​
name
string | null

Name for the vehicle

Example:

"John's Car"

​
thumbnailS3Key
string | null

S3 key for the vehicle thumbnail image

​
trust
boolean | null

Whether this vehicle is trusted

​
vehicleLicensePlate
string | null

License plate number of the vehicle

Example:

"ABC123"

Response

200 - application/json

OK

Response object for saving a vehicle.

​
error
boolean | null
​
errorMsg
string | null
​
warningMsg
string | null