Update Device

PATCH

/api/devices/{device_id}

curl --request PATCH \
  --url 'https://example.com/api/devices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?organization_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "attributes": {}, "description": "example", "firmware_version": "example", "hardware_version": "example", "name": "example", "tags": { "additionalProperty": "example" } }'

Update device

Authorizations

• HTTPBearer

Parameters

Path Parameters

device_id

required

Device Id

string format: uuid

Query Parameters

organization_id

required

Organization Id

string format: uuid

Request Body^required

Media type application/json

DeviceUpdate

Device update schema

object

attributes

Any of:

object

object

key

additional properties

any

null

null

description

Any of:

string

string

null

null

firmware_version

Any of:

string

string

null

null

hardware_version

Any of:

string

string

<= 100 characters

null

null

name

Any of:

string

string

<= 255 characters

null

null

tags

Any of:

object

object

key

additional properties

string

null

null

Example ^generated

{
  "attributes": {},
  "description": "example",
  "firmware_version": "example",
  "hardware_version": "example",
  "name": "example",
  "tags": {
    "additionalProperty": "example"
  }
}

Responses

200

Successful Response

Media type application/json

DeviceResponse

Device response schema

object

attributes

Any of:

object

object

key

additional properties

any

null

null

cpu_usage

required

Any of:

number

number

null

null

crash_count

required

Crash Count

integer

created_at

required

Created At

string format: date-time

description

Any of:

string

string

null

null

device_id

required

Device Id

string

disk_usage

required

Any of:

number

number

null

null

distro_version

Any of:

string

string

null

null

firmware_version

required

Any of:

string

string

null

null

hardware_version

required

Any of:

string

string

null

null

hostname

Any of:

string

string

null

null

id

required

Id

string format: uuid

is_active

required

Is Active

boolean

kernel

Any of:

string

string

null

null

last_boot

required

Any of:

string

string format: date-time

null

null

last_ip

required

Any of:

string

string

null

null

last_seen

required

Any of:

string

string format: date-time

null

null

mac_address

required

Any of:

string

string

null

null

memory_usage

required

Any of:

number

number

null

null

name

Any of:

string

string

<= 255 characters

null

null

organization_id

required

Organization Id

string format: uuid

os

Any of:

string

string

null

null

reboot_count

required

Reboot Count

integer

registered_at

required

Registered At

string format: date-time

serial_number

required

Any of:

string

string

null

null

status

required

DeviceStatus

Device status

string

Allowed values: online offline degraded updating error unknown

tags

Any of:

object

object

key

additional properties

string

null

null

temperature

required

Any of:

number

number

null

null

tunnel_id

Any of:

string

string

null

null

tunnel_last_seen

Any of:

string

string format: date-time

null

null

tunnel_online

Tunnel Online

boolean

tunnel_status

Tunnel Status

string

default: unknown

uptime_seconds

required

Any of:

number

number

null

null

Example

{
  "status": "online",
  "tunnel_online": false,
  "tunnel_status": "unknown"
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}