Device tag

Get all tags by device UUID

get

Device tag Resource Fields

Field
id
device
tag_key
value

---

GET /v7/device_tag

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

get

/v7/device_tag

HTTPcURLJavaScriptPython

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

Create a new device tag

post

POST /v7/device_tag

Request Body:

{
    "device": <DEVICE ID>,
    "tag_key": <KEY>,
    "value": <VALUE>
}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptional

post

/v7/device_tag

HTTPcURLJavaScriptPython

POST /v7/device_tag HTTP/1.1
Host: api.balena-cloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "device": "<DEVICE ID>",
  "tag_key": "<KEY>",
  "value": "<VALUE>"
}

Update a device tag

patch

PATCH /v7/device_tag(device=<DEVICE_ID>,tag_key='<EXISTING-KEY>')

Request Body:

{
    "value": <NEW-VALUE>
}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

DEVICE_IDanyRequired

EXISTING-KEYanyRequired

Body

application/json

objectOptional

patch

/v7/device_tag(device={DEVICE_ID},tag_key='{EXISTING-KEY}')

HTTPcURLJavaScriptPython

PATCH /v7/device_tag(device={DEVICE_ID},tag_key='{EXISTING-KEY}') HTTP/1.1
Host: api.balena-cloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "value": "<NEW-VALUE>"
}

Delete a device tag given its database ID

delete

DELETE /v7/device_tag(<TAG-ID>)

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

TAG-IDanyRequired

delete

/v7/device_tag({TAG-ID})

HTTPcURLJavaScriptPython

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