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

RegisterVersion

Register a new software version in the OTA version catalog

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • versionStringRequired

    Version string for the new OTA release being registered

    Example: 1.3.0

  • releaseNotesStringRequired

    Release notes describing changes in this version

    Example: Bug fixes and performance improvements

  • sha256ChecksumStringRequired

    SHA256 checksum of the artifact for integrity verification

    Example: abc123def456abc123def456abc123def456abc123def456abc123def456abc1

  • fileSizeStringRequired

    File size in bytes of the OTA artifact

    Example: 52428800

  • minAgentVersionStringRequired

    Minimum agent version required to apply this OTA package

    Example: 1.2.0

Responses

200 OK

On success, this API returns the following response structure.

  • 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

Endpoint

POST/api/v1/ota/versions

/api/v1/ota/versions

Operation ID

RegisterVersion

Permalink

Request Example

curl -X POST '{host}/api/v1/ota/versions' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"version":"1.3.0","releaseNotes":"Bug fixes and performance improvements","sha256Checksum":"abc123def456abc123def456abc123def456abc123def456abc123def456abc1","fileSize":52428800,"minAgentVersion":"1.2.0"}'

Response Example

200
{"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"}

Change History

This API has no change history records yet.

View all change history