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
uuid
organization
depends_on__application
actor
app_name
slug
should_be_running__release
application_type
is_for__device_type
should_track_latest_release
is_accessible_by_support_until__date
is_public
is_host
is_archived
is_discoverable
is_stored_at__repository_url
created_at

Examples

Get all fleets

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

Get all fleets associated with authenticated user

curl -X GET \
"https://api.balena-cloud.com/v6/application?\$filter=is_directly_accessible_by__user/any(dau:1%20eq%201)" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <AUTH_TOKEN>" 

Get fleet by ID

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

Get fleet by name

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

Get fleet by id along with its devices

curl -X GET \
"https://api.balena-cloud.com/v6/application(<ID>)?\$expand=owns__device" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <AUTH_TOKEN>" 

Filter public fleets from result

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

Create fleet

curl -X POST \
"https://api.balena-cloud.com/v6/application" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <AUTH_TOKEN>" \
--data '{
    "app_name": "<NAME>",
    "device_type": "<DEVICE TYPE>"
}'

Delete fleet

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

Disable automatic update tracking for a fleet

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

Enable automatic update tracking for a fleet

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

Pin entire fleet to a specific release

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