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
device
value
name

Examples

Get all device config variables for a device

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

Create a device config variable

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

Update a device config variable

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

Remove a device config variable

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