How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Afero Cloud OTA Firmware API

The Afero Over-the-Air (OTA) Update API lets a partner drive firmware releases from their own CI/CD pipeline instead of the OTA Manager web application. It creates and updates partner firmware types, creates firmware records in the partner firmware pool, uploads firmware binaries to a temporary location and moves them into the permanent repository, checks whether a name and version already exists, associates pool images with device types to make them OTA-eligible, lists and filters firmware images with tag filtering and paging, pushes an image to a specific device, dissociates an image from a device type, and lists firmware tags.

Afero Cloud OTA Firmware API is one of 4 APIs that Afero publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Firmware, Over-the-Air Updates, Device Management, and Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 19 operations across 14 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.afero.io.

19 operations 14 paths 15 schemas 1 DELETE10 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.afero.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Afero Cloud OTA Firmware API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — The OAuth 2.0 access token returned by POST /oauth/token, sent as Authorization: Bearer . Tokens expire (approximately four hours per the Afero docs).

Paths & Operations 19

Across 14 paths, the API surfaces 19 operations — 1 DELETE, 10 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

OTA 19

Over-the-air firmware management: firmware types, the firmware pool, binaries, device type associations, tags and pushes.

POST
/v1/ota/partners/{partnerId}/types
Create a partner firmware type
createFirmwareType 1 param body → 201401403404
GET
/v1/ota/partners/{partnerId}/types
Retrieve partner firmware types
listFirmwareTypes 1 param → 200401403404
GET
/v1/ota/partners/{partnerId}/types/{type}
Retrieve a firmware type by type
getFirmwareType 2 params → 200401403404
PUT
/v1/ota/partners/{partnerId}/types/{type}
Update a partner firmware type
updateFirmwareType 2 params body → 204401403404
POST
/v1/ota/partners/{partnerId}/pool
Create a firmware record in the firmware pool
createPoolFirmwareImage 1 param body → 201401403404
GET
/v1/ota/partners/{partnerId}/pool
Retrieve firmware images from the pool
listPoolFirmwareImages 5 params → 200401403404
POST
/v1/ota/partners/{partnerId}/binaries
Upload a firmware binary to a temporary location
uploadFirmwareBinary 1 param body → 200401403404
POST
/v1/ota/partners/{partnerId}/binaries/moveToRepository
Move a binary into the firmware repository
moveBinaryToRepository 1 param body → 200401403404
GET
/v1/ota/partners/{partnerId}/pool/types/{type}
Retrieve pool firmware images of a type
listPoolFirmwareImagesByType 6 params → 200401403404
GET
/v1/ota/partners/{partnerId}/pool/types/{type}/names/{name}/versions/{version}/exists
Check whether a pool firmware image exists
poolFirmwareImageExists 5 params → 200401403404
GET
/v1/ota/partners/{partnerId}/pool/types/{type}/versionNumbers/{versionNumber}/associations
Retrieve device type associations of a pool firmware image
listPoolFirmwareImageAssociations 3 params → 200401403404
PUT
/v1/ota/partners/{partnerId}/pool/types/{type}/versionNumbers/{versionNumber}
Update a firmware image in the pool
updatePoolFirmwareImage 3 params body → 204401403404
POST
/v1/ota/partners/{partnerId}/deviceTypes/{deviceTypeId}/firmwareImages
Associate a firmware image with a device type
createDeviceTypeFirmwareImage 2 params body → 201401403404
GET
/v1/ota/partners/{partnerId}/deviceTypes/{deviceTypeId}/firmwareImages
Retrieve firmware images associated with a device type
listDeviceTypeFirmwareImages 6 params → 200401403404
GET
/v1/ota/partners/{partnerId}/deviceTypes/{deviceTypeId}/firmwareImages/types/{type}
Retrieve device type firmware images by firmware type
listDeviceTypeFirmwareImagesByType 7 params → 200401403404
GET
/v1/ota/partners/{partnerId}/deviceTypes/{deviceTypeId}/firmwareImages/types/{type}/versionNumbers/{versionNumber}
Retrieve a device type firmware image by type and version number
getDeviceTypeFirmwareImage 7 params → 200401403404
DELETE
/v1/ota/partners/{partnerId}/deviceTypes/{deviceTypeId}/firmwareImages/types/{type}/versionNumbers/{versionNumber}
Dissociate a firmware image from a device type
deleteDeviceTypeFirmwareImage 4 params → 204401403404
PUT
/v1/ota/partners/{partnerId}/deviceTypes/{deviceTypeId}/firmwareImages/{firmwareImageId}/push
Push a firmware image to a device
pushFirmwareImageToDevice 3 params body → 202401403404
GET
/v1/ota/partners/{partnerId}/tags
Retrieve all firmware tags
listFirmwareTags 1 param → 200401403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are DeviceTypeFirmwareImage (14 properties), PoolFirmwareImage (11 properties), DeviceTypeFirmwareImageCreate (8 properties), FirmwareType (8 properties). Each schema is shown below with its type and property counts.

BooleanValue
object
1 property
Error
object
The Afero Cloud API error envelope, observed live on api.afero.io (2026-08-02).
6 properties
DeviceTypeFirmwareImagePage
DeviceTypeFirmwareImageCreate
object
8 properties 5 required
FirmwareType
object
8 properties
FirmwareTypeCreate
object
3 properties 2 required
FirmwareTypeUpdate
object
2 properties 1 required
Value
object
1 property 1 required
Page
object
The Afero paged result set envelope. Default page size is 50.
6 properties
PoolFirmwareImage
object
11 properties
PoolFirmwareImageUpdate
object
5 properties
PoolFirmwareImageCreate
object
7 properties 4 required
FirmwareAssociation
object
6 properties
DeviceTypeFirmwareImage
object
14 properties
PoolFirmwareImagePage

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

afero-ota-api-openapi.yml Raw ↑

Other APIs Afero publishes across the network.

Afero Cloud Authentication API
Afero Cloud Users API
Afero Cloud Devices API
Where this information came from

This is an independent, third-party profile of Afero Cloud OTA Firmware API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.