---
title: "Update route"
method: PATCH
path: "/v1/route/{routeName}"
tags: ["routes"]
---

# Update route

`PATCH /v1/route/{routeName}`

## Request

- Base URL: `https://api.comma.ai`
- URL: `https://api.comma.ai/v1/route/{routeName}`
- Auth: HTTP bearer

Update route metadata. Authenticated user must have ownership of the device from which the route was uploaded.

## Request body

- object
  - `rating` integer: Route rating
  - `is_public` boolean: Whether the route is publicly accessible

## Response `200`

JSON object containing updated route information

- Route
  - `fullname` string, required: Contains a dongle ID and timestamp of the beginning of the route
  - `dongle_id` string, required: A unique 16-character hexadecimal string. Can represent a device or a user.
  - `user_id` string, required: A unique 16-character hexadecimal string. Can represent a device or a user.
  - `is_public` boolean: Route is publicly accessible
  - `create_time` integer, required: Unix timestamp at which upload_url was first called for file in route
  - `url` string, required: Signed storage bucket URL from which route.coords and JPEGs can be downloaded
  - `share_expiry` integer, required: Unix timestamp at which signed URL expires
  - `share_sig` string, required: URL signature
  - `length` number, required: Sum of distances between GPS points in miles
  - `can` boolean: Route contains CAN messages
  - `hpgps` boolean: Route has ublox packets
  - `radar` boolean: Route contains radar tracks in CAN
  - `devicetype` 3 | 6 | 7, required: Data source - 3 = eon - 6 = comma two - 7 = comma three
  - `maxqlog` integer: Maximum qlog segment number uploaded
  - `maxqcamera` integer: Maximum qcamera segment number uploaded
  - `maxlog` integer, required: Maximum log segment number uploaded
  - `maxcamera` integer, required: Maximum road camera segment number uploaded
  - `maxdcamera` integer, required: Maximum driver camera segment number uploaded
  - `maxecamera` integer: Maximum wide road camera segment number uploaded
  - `procqlog` integer: Maximum qlog segment number processed
  - `procqcamera` integer: Maximum qcamera segment number processed
  - `proclog` integer, required: Maximum log segment number processed
  - `proccamera` integer, required: Maximum road camera segment number processed
  - `start_lat` number: First latitude recorded in route from GPS
  - `start_lng` number: First longitude recorded in route from GPS
  - `start_time` number, required: Unix timestamp at beginning of route
  - `end_lat` number: Last latitude recorded in route from GPS
  - `end_lng` number: Last longitude recorded in route from GPS
  - `end_time` number, required: Unix timestamp at end of last segment in route
  - `passive` boolean: openpilot is running in passive mode
  - `version` string: openpilot version
  - `git_commit` string: git commit hash
  - `git_branch` string: git branch
  - `git_remote` string: git remote url
  - `git_dirty` boolean: git working tree is dirty
  - `platform` string: openpilot platform name
  - `vin` string: 17-character alphanumeric string
  - `init_logmonotime` integer: Minimum logMonoTime from openpilot log

## Changes

- **2022-11-27** `5b1478ce801f`: 1 info
  - api tag `routes` added
- **2022-11-27** `04af598547de`: 1 info
  - the endpoint scheme security `AuthUser` was added to the API
- **2022-11-27** `f738738638c8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/comma/apis/comma-api/changes/v1/route/:routeName/patch.md)

---

[API](https://skmtc.dev/comma/apis/comma-api.md) - [All operations](https://skmtc.dev/comma/apis/comma-api/llms.txt) - [OpenAPI document](https://skmtc.dev/comma/apis/comma-api/revisions/24f7dbc922ad?raw)