Skip to main content
ZStack
Infrastructure/OTA Versions & Policies

RegisterVersion

Register a new software version in the OTA version catalog

POST/api/v1/ota/versions

Operation ID

RegisterVersion

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • version
    StringRequired

    Version string for the new OTA release being registered

    Example: 1.3.0

  • releaseNotes
    StringRequired

    Release notes describing changes in this version

    Example: Bug fixes and performance improvements

  • sha256Checksum
    StringRequired

    SHA256 checksum of the artifact for integrity verification

    Example: abc123def456abc123def456abc123def456abc123def456abc123def456abc1

  • fileSize
    StringRequired

    File size in bytes of the OTA artifact

    Example: 52428800

  • minAgentVersion
    StringRequired

    Minimum agent version required to apply this OTA package

    Example: 1.2.0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • id
    String

    Unique identifier of this OTA version record

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

  • version
    String

    Version string for this OTA release

    Example: 1.3.0

  • releaseNotes
    String

    Human-readable release notes for this version

    Example: Bug fixes and performance improvements

  • sha256Checksum
    String

    SHA256 checksum of the OTA artifact

    Example: abc123def456abc123def456abc123def456abc123def456abc123def456abc1

  • fileSize
    String

    Size of the OTA artifact in bytes

    Example: 52428800

  • minAgentVersion
    String

    Minimum agent version required to accept this OTA package

    Example: 1.2.0

  • status
    String

    Publication status of this OTA version

    Example: active

  • deprecateReason
    String

    Reason this version was deprecated, if applicable

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

  • createdAt
    String

    Created at

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

  • updatedAt
    String

    Updated at

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