Improve this doc
Detailed information for resources

Available fields

id
user
owns__device
depends_on__application
actor
app_name
git_repository
commit
application_type
device_type
should_track_latest_release
is_accessible_by_support_until__date

Examples

Get all applications

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

Get application by ID

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

Get application by name

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

Get application by id along with its devices

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

Create application

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

Delete application

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

Disable automatic update tracking for an application

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

Enable automatic update tracking for an application

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

Set entire fleet to a specific commit

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