devices

Update device alias

Changed on
patch/v1/devices/{dongleId}

Request

  • Base URL
    https://api.comma.ai
  • Auth
    HTTP bearer

Request body

aliasstring required

Response

JSON object containing the updated device's information

dongle_idstring required

A unique 16-character hexadecimal string. Can represent a device or a user.

aliasstring required

Device nickname

serialstring required

Device serial number

athena_hoststring nullable

Last connected athena server hostname

last_athena_pinginteger

Unix timestamp of last athena ping

ignore_uploadsboolean nullable

Uploads are ignored from this device

is_pairedboolean required

Device has an owner

is_ownerboolean

Authenticated user has write-access to the device

public_keystring nullable required

2048-bit public RSA key

primeboolean required

Device has a prime subscription

prime_type0 | 1 | 2 | 3 | 4 required

Prime subscription type

  • 0 = None
  • 1 = Magenta
  • 2 = Lite
  • 3 = Blue
  • 4 = Magenta New
trial_claimedboolean nullable required

Device prime trial is claimed

device_type'app' | 'neo' | 'panda' | 'two' | 'freon' | 'pc' | 'three' required

Device type

last_gps_timeinteger nullable required

Unix timestamp, in milliseconds

last_gps_latnumber nullable required

Latitude, in decimal degrees

last_gps_lngnumber nullable required

Longitude, in decimal degrees

last_gps_accuracynumber nullable required

Accuracy, in metres

last_gps_speednumber nullable required

Speed, in metres per second

last_gps_bearingnumber nullable required

Direction angle, in degrees from north

openpilot_versionstring nullable

openpilot version

sim_idstring nullable required

Last known SIM ID of the device

Example response

{
  "dongle_id": "1a2b3c4d5e6f7a8b"
}

Changes

    • info

      the response optional property became read-only for the status

    • info

      the response optional property became read-only for the status

    • info

      the response optional property became read-only for the status

    • info

      the response optional property became read-only for the status

    • info

      the response optional property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      api tag devices added