Improve this doc
Detailed information for resources

balenaCloud API Resources

Note: We recently renamed applications to fleets and are in the process of updating our API resources. Application resources continue to function correctly and can be used to work with fleets. Find out more about the changes here.

Available fields

id
created_at
device
name
value

Examples

Get all device environment variables for a device by UUID

curl -X GET \
"https://api.balena-cloud.com/v7/device_environment_variable?\$filter=device/any(d:d/uuid%20eq%20'<DEVICE_UUID>')" \
-H  "Content-Type: application/json"  \
-H "Authorization: Bearer <AUTH_TOKEN>" 

Get all device environment variables for a device by ID

curl -X GET \
"https://api.balena-cloud.com/v7/device_environment_variable?\$filter=device%20eq%20<DEVICE ID>" \
-H  "Content-Type: application/json"  \
-H "Authorization: Bearer <AUTH_TOKEN>" 

Create a device environment variable

curl -X POST \
"https://api.balena-cloud.com/v7/device_environment_variable" \
-H  "Content-Type: application/json"  \
-H "Authorization: Bearer <AUTH_TOKEN>" \
--data '{
    "device": "<DEVICE ID>",
    "name": "<NAME>",
    "value": "<VALUE>"
}'

Update a device environment variable

curl -X PATCH \
"https://api.balena-cloud.com/v7/device_environment_variable(<ID>)" \
-H  "Content-Type: application/json"  \
-H "Authorization: Bearer <AUTH_TOKEN>" \
--data '{
    "value": "<NEW VALUE>"
}'

Remove a device environment variable

curl -X DELETE \
"https://api.balena-cloud.com/v7/device_environment_variable(<ID>)" \
-H  "Content-Type: application/json"  \
-H "Authorization: Bearer <AUTH_TOKEN>"