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

Amazon FreeRTOS OTA Updates API

Over-the-air firmware update management

Amazon FreeRTOS OTA Updates API is one of 3 APIs that Amazon FreeRTOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 10 JSON Schema definitions.

Tagged areas include OTA Updates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, an API reference, and 10 JSON Schemas.

This API exposes 4 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 2021-11-29.

Requests are made against a single base URL, https://iot.{region}.amazonaws.com.

4 operations 2 paths 5 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2021-11-29
Base URL
https://iot.amazonaws.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Amazon FreeRTOS OTA Updates API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (awsSigV4). By default, every request must be authenticated.

  • awsSigV4 — AWS Signature Version 4

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

OTA Updates 4

Over-the-air firmware update management

POST
/otaUpdates
Create OTA Update
createOtaUpdate body → 200400500
GET
/otaUpdates
List OTA Updates
listOtaUpdates 3 params → 200400500
GET
/otaUpdates/{otaUpdateId}
Get OTA Update
getOtaUpdate 1 param → 200400404500
DELETE
/otaUpdates/{otaUpdateId}
Delete OTA Update
deleteOtaUpdate 3 params → 200400404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are OtaUpdate (10 properties), CreateOtaUpdateRequest (8 properties), OtaUpdateSummary (3 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
Standard error response.
2 properties
CreateOtaUpdateRequest
object
8 properties 3 required
OtaUpdate
object
An over-the-air (OTA) firmware update job for FreeRTOS devices.
10 properties 2 required
OtaUpdateSummary
object
Summary of an OTA update.
3 properties
OtaUpdateInfo
object
Detailed information about an OTA update.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-freertos-ota-updates-api-openapi.yml Raw ↑

Other APIs Amazon FreeRTOS publishes across the network.

Amazon FreeRTOS Software Configurations API
Amazon FreeRTOS Tags API
Where this information came from

This is an independent, third-party profile of Amazon FreeRTOS OTA Updates 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.