Fleet

Get all fleets of an organization by its HANDLE

get

Fleet Resource Fields

Field
id
uuid
organization
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

---

GET /v7/application

Usage Variations

---

Get all fleets

GET /v7/application

Note: This will also include all public fleets of the platform. In most cases retrieving the fleets by their organization will be preferable.

---

Get all fleets associated with authenticated user

GET /v7/application?$filter=is_directly_accessible_by__user/any(dau:true)

---

Get fleet by name

GET /v7/application?$filter=app_name eq '<NAME>'

---

Filter public fleets from result

GET /v7/application?$filter=is_public eq false

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

get

/v7/application

HTTPcURLJavaScriptPython

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

Create fleet

post

POST /v7/application

Request Body:

{
    "app_name": <NAME>,
    "organization": <ORGANIZATION_ID>,
    "is_for__device_type": <DEVICE_TYPE_ID>
}

To retrieve the numeric ORGANIZATION_ID & DEVICE_TYPE_ID, check the respective documentation page for the organization & device type resources.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptional

post

/v7/application

HTTPcURLJavaScriptPython

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

{
  "app_name": "<NAME>",
  "organization": "<ORGANIZATION_ID>",
  "is_for__device_type": "<DEVICE_TYPE_ID>"
}

Get fleet by ID

get

GET /v7/application(<ID>)

Usage Variations

---

Get fleet by id along with its devices

GET /v7/application(<ID>)?$expand=owns__device

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IDanyRequired

get

/v7/application({ID})

HTTPcURLJavaScriptPython

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

Delete fleet

delete

DELETE /v7/application(<ID>)

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IDanyRequired

delete

/v7/application({ID})

HTTPcURLJavaScriptPython

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

Pin entire fleet to a specific release by ID

patch

PATCH /v7/application(<ID>)

Request Body:

{
    "should_be_running__release": <RELEASE ID>,
    "should_track_latest_release": false
}

Usage Variations

---

Disable automatic update tracking for a fleet

PATCH /v7/application(<ID>)

Request Body:

{
    "should_track_latest_release": false
}

---

Enable automatic update tracking for a fleet

PATCH /v7/application(<ID>)

Request Body:

{
    "should_track_latest_release": true
}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IDanyRequired

Body

application/json

objectOptional

patch

/v7/application({ID})

HTTPcURLJavaScriptPython

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

{
  "should_be_running__release": "<RELEASE ID>",
  "should_track_latest_release": false
}

Pin entire fleet to a specific release by IDDisable automatic update tracking for a fleetEnable automatic update tracking for a fleet

Get fleet by SLUG

get

GET /v7/application(slug='<SLUG>')

Usage Variations

---

Get fleet by SLUG along with its devices

GET /v7/application(slug='<SLUG>')?$expand=owns__device

---

Get the target release of a fleet

GET /v7/application(slug='<SLUG>')?$select=should_be_running__release

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

SLUGanyRequired

get

/v7/application(slug='{SLUG}')

HTTPcURLJavaScriptPython

GET /v7/application(slug='{SLUG}') HTTP/1.1
Host: api.balena-cloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Pin entire fleet to a specific release by SLUG

patch

PATCH /v7/application(slug='<SLUG>')

Request Body:

{
    "should_be_running__release": <RELEASE ID>,
    "should_track_latest_release": false
}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

SLUGanyRequired

Body

application/json

objectOptional

patch

/v7/application(slug='{SLUG}')

HTTPcURLJavaScriptPython

PATCH /v7/application(slug='{SLUG}') HTTP/1.1
Host: api.balena-cloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "should_be_running__release": "<RELEASE ID>",
  "should_track_latest_release": false
}