Balena

Balena is a complete platform for building, deploying, and managing fleets of connected Linux devices. The platform combines balenaOS, balenaEngine, balenaCloud, the balena CLI, and the balena SDK so teams can build container-based device images and continuously deliver them to devices in the field. The balenaCloud REST API exposes device, fleet, release, and organization management using OData-style queries.

5 APIs 0 Features

ContainersDevice ManagementEdgeEmbedded LinuxFleet ManagementIoTOTAProvisioningReleases

APIs

Balena Cloud API

The balenaCloud REST API is the primary interface to the balena platform. It exposes resources for devices, fleets (applications), releases, environment variables, organizations...

Balena Devices API

Provision, inspect, configure, and remove devices in balenaCloud, including environment variables, tags, status, and OS information.

Balena Fleets (Applications) API

Manage balena fleets, formerly known as applications, that group devices and releases for deployment.

Balena Releases API

Manage container-based releases and their assets, pinning, and rollout across a fleet.

Balena Supervisor API

On-device REST API exposed by balena Supervisor for local control of containers, application state, host configuration, reboot, shutdown, and update checks.

Collections

Balena Cloud API

OPEN

Pricing Plans

Balena Plans Pricing

1 plans

PLANS

Rate Limits

Balena Rate Limits

2 limits

RATE LIMITS

FinOps

Balena Finops

FINOPS

Resources

Sources

opencollection: 1.0.0
info:
  name: Balena Cloud API
  version: v7
items:
- info:
    name: Devices
    type: folder
  items:
  - info:
      name: List devices
      type: http
    http:
      method: GET
      url: https://api.balena-cloud.com/v7/device
      params:
      - name: $select
        value: ''
        type: query
      - name: $filter
        value: ''
        type: query
      - name: $expand
        value: ''
        type: query
      - name: $top
        value: ''
        type: query
      - name: $skip
        value: ''
        type: query
      - name: $orderby
        value: ''
        type: query
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: 'List devices using OData-style queries. Supports `$select`, `$filter`,

      `$expand`, `$top`, `$skip`, and `$orderby`.

      '
  - info:
      name: Create a device
      type: http
    http:
      method: POST
      url: https://api.balena-cloud.com/v7/device
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Create a device
  - info:
      name: Get a device by id
      type: http
    http:
      method: GET
      url: https://api.balena-cloud.com/v7/device(:id)
      params:
      - name: id
        value: ''
        type: path
      - name: $select
        value: ''
        type: query
      - name: $expand
        value: ''
        type: query
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get a device by id
  - info:
      name: Modify a device
      type: http
    http:
      method: PATCH
      url: https://api.balena-cloud.com/v7/device(:id)
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Modify a device
  - info:
      name: Delete a device
      type: http
    http:
      method: DELETE
      url: https://api.balena-cloud.com/v7/device(:id)
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Delete a device
- info:
    name: Applications
    type: folder
  items:
  - info:
      name: List applications (fleets)
      type: http
    http:
      method: GET
      url: https://api.balena-cloud.com/v7/application
      params:
      - name: $select
        value: ''
        type: query
      - name: $filter
        value: ''
        type: query
      - name: $expand
        value: ''
        type: query
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: List applications (fleets)
  - info:
      name: Create an application (fleet)
      type: http
    http:
      method: POST
      url: https://api.balena-cloud.com/v7/application
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Create an application (fleet)
  - info:
      name: Get an application
      type: http
    http:
      method: GET
      url: https://api.balena-cloud.com/v7/application(:id)
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get an application
  - info:
      name: Delete an application
      type: http
    http:
      method: DELETE
      url: https://api.balena-cloud.com/v7/application(:id)
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Delete an application
- info:
    name: Releases
    type: folder
  items:
  - info:
      name: List releases
      type: http
    http:
      method: GET
      url: https://api.balena-cloud.com/v7/release
      params:
      - name: $select
        value: ''
        type: query
      - name: $filter
        value: ''
        type: query
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: List releases
- info:
    name: Device Tags
    type: folder
  items:
  - info:
      name: List device tags
      type: http
    http:
      method: GET
      url: https://api.balena-cloud.com/v7/device_tag
      params:
      - name: $filter
        value: ''
        type: query
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: List device tags
  - info:
      name: Create a device tag
      type: http
    http:
      method: POST
      url: https://api.balena-cloud.com/v7/device_tag
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Create a device tag
bundled: true