Device service variable

Get all service variables for a device by UUID

get

Device service variable Resource Fields

Field
id
created_at
service_install
value
name

---

GET /v7/device_service_environment_variable

Usage Variations

---

Get all service variables for a device by UUID, including the service name

GET /v7/device_service_environment_variable?$filter=service_install/any(si:si/device/any(d:d/uuid eq '<DEVICE_UUID>'))&$expand=service_install($expand=installs__service($select=id,service_name))

---

Get all service variables for a device by ID

GET /v7/device_service_environment_variable?$filter=service_install/device eq <DEVICE ID>

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

get

/v7/device_service_environment_variable

HTTPcURLJavaScriptPython

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

Create a device service variable

post

POST /v7/device_service_environment_variable

Request Body:

{
    "service_install": <SERVICE INSTALL ID>,
    "name": <NAME>,
    "value": <VALUE>
}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptional

post

/v7/device_service_environment_variable

HTTPcURLJavaScriptPython

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

{
  "service_install": "<SERVICE INSTALL ID>",
  "name": "<NAME>",
  "value": "<VALUE>"
}

Remove a device service variable

delete

DELETE /v7/device_service_environment_variable(<ID>)

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IDanyRequired

delete

/v7/device_service_environment_variable({ID})

HTTPcURLJavaScriptPython

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

Update a device service variable

patch

PATCH /v7/device_service_environment_variable(<ID>)

Request Body:

{
    "value": <NEW VALUE>
}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IDanyRequired

Body

application/json

objectOptional

patch

/v7/device_service_environment_variable({ID})

HTTPcURLJavaScriptPython

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

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