---
updatedAt: 2025-11-11T22:56:23.000Z
agentTools:
  projectIndex: https://pegasus.digitalcomtech.com/llms.txt
---

# Update a vehicle

Update a vehicle

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Pegasus Cloud IoT API",
    "description": "Pegasus IoT Cloud API reference documentation. [Github Repo](https://github.com/dctdevelop/pegasus) / [Release notes](https://github.com/dctdevelop/pegasus/tree/master/releases)",
    "contact": {
      "email": "developer@digitalcomtech.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version": "1.0.12"
  },
  "servers": [
    {
      "url": "https://api.pegasusgateway.com",
      "description": "Production server"
    },
    {
      "url": "https://auth.pegasusgateway.com",
      "description": "Authentication server"
    }
  ],
  "tags": [
    {
      "name": "Vehicles"
    }
  ],
  "paths": {
    "/vehicles/{id}": {
      "put": {
        "tags": [
          "Vehicles"
        ],
        "summary": "Update a vehicle",
        "description": "Update a vehicle",
        "operationId": "updateVehicle",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Vehicle ID to search",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/requestBodyVehicle"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/responseVehicle200"
                }
              }
            }
          },
          "400": {
            "description": "invalid input, object invalid"
          },
          "409": {
            "description": "an existing item already exists"
          }
        },
        "security": [
          {
            "apikeyAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "requestBodyVehicle": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the vehicle",
            "example": "Blue Truck"
          },
          "alias": {
            "type": "string",
            "description": "Vehicle alias",
            "example": "alpha"
          },
          "device": {
            "type": "number",
            "description": "Device ID to associate",
            "example": 358741051451234
          },
          "year": {
            "type": "string",
            "description": "Vehicle year",
            "example": "2022"
          },
          "make": {
            "type": "string",
            "description": "Vehicle make",
            "example": "Audi"
          },
          "model": {
            "type": "string",
            "description": "Vehicle model",
            "example": "A4"
          },
          "license_plate": {
            "type": "string",
            "description": "Vehicle license plate",
            "example": "ABC123"
          },
          "color": {
            "type": "string",
            "description": "Vehicle color",
            "example": "Black"
          },
          "vin": {
            "type": "string",
            "description": "Vehicle Identification Number",
            "example": "WMWZC52080WM24755"
          },
          "tank_volume": {
            "type": "number",
            "description": "Vehicle tank volume",
            "example": 16
          },
          "primary": {
            "type": "number",
            "description": "Primary group ID associated",
            "example": 123
          },
          "tank_unit": {
            "type": "string",
            "description": "Tank unit (liter or gallon)",
            "example": "liter"
          },
          "range": {
            "type": "number",
            "description": "Distance vehicle can travel on a full tank",
            "example": 390
          },
          "description": {
            "type": "string",
            "description": "Description for vehicle",
            "example": "Custom description"
          },
          "groups": {
            "type": "array",
            "description": "IDs of groups the asset belongs to",
            "items": {
              "type": "number",
              "example": 1
            }
          },
          "properties": {
            "$ref": "#/components/schemas/requestBodyVehicle_properties"
          }
        }
      },
      "responseVehicle200": {
        "type": "object",
        "properties": {
          "info": {
            "type": "object",
            "allOf": [
              {
                "description": "Information on the vehicle"
              },
              {
                "type": "object",
                "properties": {
                  "range_unit": {
                    "type": "string",
                    "description": "Range unit (km or mi)",
                    "example": "km"
                  },
                  "description": {
                    "type": "string",
                    "description": "Vehicle description",
                    "example": "Custom description"
                  },
                  "tank_volume": {
                    "type": "number",
                    "description": "Tank volume",
                    "example": 16
                  },
                  "color": {
                    "type": "string",
                    "description": "Vehicle color",
                    "example": "Blue"
                  },
                  "make": {
                    "type": "string",
                    "description": "Make of vehicle",
                    "example": "Audi"
                  },
                  "vin": {
                    "type": "string",
                    "description": "Vehicle Identification Number",
                    "example": "WMWZC52080WM24755"
                  },
                  "license_plate": {
                    "type": "string",
                    "description": "Vehicle license plate",
                    "example": "ABC123"
                  },
                  "alias": {
                    "type": "string",
                    "description": "Vehicle alias (used with Amazon Alexa integration)",
                    "example": "alpha"
                  },
                  "range": {
                    "type": "number",
                    "description": "Vehicle range",
                    "example": 380
                  },
                  "year": {
                    "type": "number",
                    "description": "Vehicle year",
                    "example": 2022
                  },
                  "model": {
                    "type": "string",
                    "description": "Vehicle model",
                    "example": "A4"
                  },
                  "tank_unit": {
                    "type": "string",
                    "description": "Tank unit (gallon or liter)",
                    "example": "gallon"
                  }
                }
              }
            ]
          },
          "associations": {
            "type": "array",
            "items": {
              "allOf": [
                {
                  "description": "Vehicle device association history"
                },
                {
                  "type": "object",
                  "properties": {
                    "device": {
                      "type": "number",
                      "description": "Device assocated",
                      "example": 357042067941234
                    },
                    "vehicle": {
                      "type": "number",
                      "description": "Vehicle ID",
                      "example": 3498
                    },
                    "id": {
                      "type": "number",
                      "description": "Association ID",
                      "example": 5234
                    },
                    "association": {
                      "type": "boolean",
                      "description": "True if vehicle was associated from asset",
                      "example": true
                    },
                    "time": {
                      "type": "number",
                      "description": "Epoch of association or disassociation",
                      "example": 1582760414
                    }
                  }
                }
              ]
            }
          },
          "__updated": {
            "type": "number",
            "description": "Epoch of last modification done on vehicle",
            "example": 1649865610.294368
          },
          "__created": {
            "type": "number",
            "description": "Epoch of creation",
            "example": 1592351212.609387
          },
          "associated_at": {
            "type": "number",
            "description": "Epoch of time vehicle was associated to a device",
            "example": 1599168670
          },
          "name": {
            "type": "string",
            "description": "Name of vehicle",
            "example": "Blue Truck"
          },
          "id": {
            "type": "number",
            "description": "Vehicle ID",
            "example": 123
          },
          "primary": {
            "type": "number",
            "description": "Primar group ID",
            "example": 432
          },
          "device": {
            "type": "number",
            "description": "IMEI of the associated device",
            "example": 450005394070183
          },
          "groups": {
            "type": "array",
            "description": "IDs of groups the vehicle belongs to",
            "items": {
              "type": "number",
              "example": 15
            }
          },
          "configuration": {
            "type": "string",
            "description": "Shortcode to identify configuration (ky)",
            "example": "q918"
          },
          "type": {
            "type": "string",
            "description": "Type of entity",
            "example": "vehicle"
          },
          "images": {
            "type": "object",
            "allOf": [
              {
                "description": "Images information for vehicle"
              },
              {
                "type": "object",
                "properties": {
                  "photo": {
                    "type": "boolean",
                    "description": "Vehicle photo",
                    "example": false
                  },
                  "icon": {
                    "type": "boolean",
                    "description": "Vehicle icon",
                    "example": false
                  },
                  "on_icon": {
                    "type": "boolean",
                    "description": "Vehicle ON icon",
                    "example": false
                  },
                  "idle_icon": {
                    "type": "boolean",
                    "description": "Vehicle idling icon",
                    "example": false
                  },
                  "off_icon": {
                    "type": "boolean",
                    "description": "Vehicle OFF icon",
                    "example": false
                  }
                }
              }
            ]
          },
          "properties": {
            "type": "object",
            "allOf": [
              {
                "description": "Properties of the asset"
              },
              {
                "type": "object",
                "properties": {
                  "custom": {
                    "type": "string",
                    "description": "Sample property",
                    "example": "value"
                  }
                }
              }
            ]
          },
          "__version": {
            "type": "string",
            "description": "API version info",
            "example": "7.0.0"
          }
        }
      },
      "requestBodyVehicle_properties": {
        "type": "object",
        "properties": {
          "custom": {
            "type": "string",
            "description": "Custom value",
            "example": "value"
          }
        },
        "description": "Vehicle properties"
      }
    },
    "securitySchemes": {
      "apikeyAuth": {
        "type": "apiKey",
        "name": "authenticate",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```