Skip to main content
Infrastructure/OTA Versions & Policies

VerifyIntegrity

Verify the integrity of a downloaded update package using its checksum

POST/api/v1/ota/versions/{id}/verify

Operation ID

VerifyIntegrity

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

Path Parameters

  • id
    StringRequired

    ID of the OTA version record to verify integrity for

Body Fields

  • checksum
    StringRequired

    Checksum to compare against the stored expected checksum

    Example: abc123def456

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • versionId
    String

    ID of the OTA version that was integrity-checked

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

  • expectedChecksum
    String

    Checksum stored in the version registry

    Example: abc123def456

  • providedChecksum
    String

    Checksum provided by the caller for comparison

    Example: abc123def456

  • match
    Boolean

    Whether the provided checksum matches the expected checksum

    Example: true

  • message
    String

    Human-readable result message for the integrity check

    Example: Checksum matches, artifact is intact