Skip to main content
API Explorer|API Explorer
Infrastructure/OTA Versions & Policies
GETOTASince 1.0SynchronousAuth Required

ListVersions

List all registered software versions in the version catalog

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Query Parameters

Request Inputs

Query Parameters

  • statusString

    Filter OTA versions by status, e.g. active, deprecated

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • idString

      Unique identifier of this OTA version record

      Example: ver-a1b2c3d4-e5f6-7890-abcd-ef1234567890

    • versionString

      Version string for this OTA release

      Example: 1.3.0

    • releaseNotesString

      Human-readable release notes for this version

      Example: Bug fixes and performance improvements

    • sha256ChecksumString

      SHA256 checksum of the OTA artifact

      Example: abc123def456abc123def456abc123def456abc123def456abc123def456abc1

    • fileSizeString

      Size of the OTA artifact in bytes

      Example: 52428800

    • minAgentVersionString

      Minimum agent version required to accept this OTA package

      Example: 1.2.0

    • statusString

      Publication status of this OTA version

      Example: active

    • deprecateReasonString

      Reason this version was deprecated, if applicable

      Example: Security vulnerability in v1.3.0; upgrade to v1.3.1

    • createdAtString

      Created at

      Example: 2026-01-15T08:00:00Z

    • updatedAtString

      Updated at

      Example: 2026-01-15T08:00:00Z

  • totalInteger

    Total number of OTA versions matching the query

    Example: 5

  • limitInteger

    Maximum number of items returned per page

    Example: 20

  • offsetInteger

    Number of items skipped before the current page

    Example: 20

Endpoint

GET/api/v1/ota/versions

/api/v1/ota/versions

Operation ID

ListVersions

Permalink

Request Example

curl -X GET '{host}/api/v1/ota/versions' -H 'Authorization: Bearer {token}'

Response Example

200
{"items": [{"id": "ver-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "version": "1.3.0", "releaseNotes": "Bug fixes and performance improvements", "sha256Checksum": "abc123def456abc123def456abc123def456abc123def456abc123def456abc1", "fileSize": 52428800, "minAgentVersion": "1.2.0", "status": "active", "deprecateReason": "Security vulnerability in v1.3.0; upgrade to v1.3.1"}], "total": 5, "limit": 20, "offset": 20}

Change History

This API has no change history records yet.

View all change history