Device

Get all devices

get

Device Resource Fields

Field
id
belongs_to__application
belongs_to__user
actor
device_name
is_of__device_type
uuid
is_running__release
is_pinned_on__release
should_be_running__release
note
local_id
status
overall_status
is_online
last_connectivity_event
is_connected_to_vpn
last_vpn_event
ip_address
mac_address
public_address
os_version
os_variant
supervisor_version
should_be_managed_by__release
is_managed_by__service_instance
provisioning_progress
provisioning_state
download_progress
is_web_accessible
longitude
latitude
location
custom_longitude
custom_latitude
is_locked_until__date
is_accessible_by_support_until__date
created_at
is_active
api_heartbeat_state
memory_usage
memory_total
storage_block_device
storage_usage
storage_total
cpu_temp
cpu_usage
cpu_id
is_undervolted

---

GET /v7/device

Usage Variations

---

Get all devices by fleet

GET /v7/device?$filter=belongs_to__application eq '<FLEET ID>'

---

Get multiple devices by UUID

GET /v7/device?$filter=uuid in ('<UUID1>','<UUID2>','<UUID3>')

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

get

/v7/device

HTTPcURLJavaScriptPython

GET /v7/device HTTP/1.1
Host: api.balena-cloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Get device by ID

get

GET /v7/device(<ID>)

Usage Variations

---

Get the device overall_status field

GET /v7/device(<ID>)?$select=overall_status

The overall_status field is returned only when explicitly requested with $select.

---

Get the release currently running on a device

GET /v7/device(<ID>)?$select=is_running__release

---

Get the release a device is pinned to

GET /v7/device(<ID>)?$select=is_pinned_on__release

Note: is_pinned_on__release will be null/not set if the device isn't pinned to any release, in which case the device will be tracking the release of the application it belongs to.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IDanyRequired

get

/v7/device({ID})

HTTPcURLJavaScriptPython

GET /v7/device({ID}) HTTP/1.1
Host: api.balena-cloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Delete device

delete

DELETE /v7/device(<ID>)

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IDanyRequired

delete

/v7/device({ID})

HTTPcURLJavaScriptPython

DELETE /v7/device({ID}) HTTP/1.1
Host: api.balena-cloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Pin device to a specific release by ID

patch

PATCH /v7/device(<ID>)

Request Body:

{
    "is_pinned_on__release": <RELEASE ID>
}

Usage Variations

---

Rename device

PATCH /v7/device(<ID>)

Request Body:

{
    "device_name": <NEW NAME>
}

---

Add note to a device

PATCH /v7/device(<ID>)

Request Body:

{
    "note": <NEW NOTE>
}

---

Move device to another fleet

PATCH /v7/device(<ID>)

Request Body:

{
    "belongs_to__application": <FLEET ID>
}

---

Deactivate an offline device (CHARGEABLE)

PATCH /v7/device(<ID>)

Request Body:

{
    "is_active": false
}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IDanyRequired

Body

application/json

objectOptional

patch

/v7/device({ID})

HTTPcURLJavaScriptPython

PATCH /v7/device({ID}) HTTP/1.1
Host: api.balena-cloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "is_pinned_on__release": "<RELEASE ID>"
}

Pin device to a specific release by IDRename deviceAdd note to a deviceMove device to another fleetDeactivate an offline device (CHARGEABLE)

Get device by UUID

get

GET /v7/device(uuid='<UUID>')

Usage Variations

---

Get the target release of a device

GET /v7/device(uuid='<UUID>')?$select=should_be_running__release

This will be the release that the device is pinned to, or the target release of the fleet for non-pinned devices.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

UUIDanyRequired

get

/v7/device(uuid='{UUID}')

HTTPcURLJavaScriptPython

GET /v7/device(uuid='{UUID}') HTTP/1.1
Host: api.balena-cloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Pin device to a specific release by UUID

patch

PATCH /v7/device(uuid='<UUID>')

Request Body:

{
    "is_pinned_on__release": <RELEASE ID>
}

Usage Variations

---

Mark a device to be updated to a specific supervisor release

PATCH /v7/device(uuid='<UUID>')

Request Body:

{
    "should_be_managed_by__release": <SUPERVISOR RELEASE ID>
}

To request a list of available supervisor versions, check the respective documentation page for the supervisor release resource.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

UUIDanyRequired

Body

application/json

objectOptional

patch

/v7/device(uuid='{UUID}')

HTTPcURLJavaScriptPython

PATCH /v7/device(uuid='{UUID}') HTTP/1.1
Host: api.balena-cloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "is_pinned_on__release": "<RELEASE ID>"
}

Pin device to a specific release by UUIDMark a device to be updated to a specific supervisor release