# Device tag

## Get all tags by device UUID

> \## Device tag Resource Fields\
> \
> \| Field |\
> \| :--- |\
> \| \`id\` |\
> \| \`device\` |\
> \| \`tag\_key\` |\
> \| \`value\` |\
> \
> \
> \---\
> \
> \`GET /v7/device\_tag\`

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"servers":[{"url":"https://api.balena-cloud.com"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v7/device_tag":{"get":{"tags":["Device tag"],"summary":"Get all tags by device UUID","description":"## Device tag Resource Fields\n\n| Field |\n| :--- |\n| `id` |\n| `device` |\n| `tag_key` |\n| `value` |\n\n\n---\n\n`GET /v7/device_tag`"}}}}
```

## Create a new device tag

> \`POST /v7/device\_tag\`\
> \
> \*\*Request Body:\*\*\
> \`\`\`json\
> {\
> &#x20;   "device": \<DEVICE ID>,\
> &#x20;   "tag\_key": \<KEY>,\
> &#x20;   "value": \<VALUE>\
> }\
> \`\`\`

````json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"servers":[{"url":"https://api.balena-cloud.com"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v7/device_tag":{"post":{"tags":["Device tag"],"summary":"Create a new device tag","description":"`POST /v7/device_tag`\n\n**Request Body:**\n```json\n{\n    \"device\": <DEVICE ID>,\n    \"tag_key\": <KEY>,\n    \"value\": <VALUE>\n}\n```","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}}}}}}
````

## Update a device tag

> \`PATCH /v7/device\_tag(device=\<DEVICE\_ID>,tag\_key='\<EXISTING-KEY>')\`\
> \
> \*\*Request Body:\*\*\
> \`\`\`json\
> {\
> &#x20;   "value": \<NEW-VALUE>\
> }\
> \`\`\`

````json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"servers":[{"url":"https://api.balena-cloud.com"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v7/device_tag(device={DEVICE_ID},tag_key='{EXISTING-KEY}')":{"patch":{"tags":["Device tag"],"summary":"Update a device tag","description":"`PATCH /v7/device_tag(device=<DEVICE_ID>,tag_key='<EXISTING-KEY>')`\n\n**Request Body:**\n```json\n{\n    \"value\": <NEW-VALUE>\n}\n```","parameters":[{"name":"DEVICE_ID","in":"path","required":true},{"name":"EXISTING-KEY","in":"path","required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}}}}}}
````

## Delete a device tag given its database ID

> \`DELETE /v7/device\_tag(\<TAG-ID>)\`

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"servers":[{"url":"https://api.balena-cloud.com"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/v7/device_tag({TAG-ID})":{"delete":{"tags":["Device tag"],"summary":"Delete a device tag given its database ID","description":"`DELETE /v7/device_tag(<TAG-ID>)`","parameters":[{"name":"TAG-ID","in":"path","required":true}]}}}}
```