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

VerifyIntegrity

Verify the integrity of a downloaded update package using its checksum

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • idStringRequired

    ID of the OTA version record to verify integrity for

Body Fields

  • checksumStringRequired

    Checksum to compare against the stored expected checksum

    Example: abc123def456

Responses

200 OK

On success, this API returns the following response structure.

  • versionIdString

    ID of the OTA version that was integrity-checked

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

  • expectedChecksumString

    Checksum stored in the version registry

    Example: abc123def456

  • providedChecksumString

    Checksum provided by the caller for comparison

    Example: abc123def456

  • matchBoolean

    Whether the provided checksum matches the expected checksum

    Example: true

  • messageString

    Human-readable result message for the integrity check

    Example: Checksum matches, artifact is intact

Endpoint

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

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

Operation ID

VerifyIntegrity

Permalink

Request Example

curl -X POST '{host}/api/v1/ota/versions/{id}/verify' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"checksum":"abc123def456"}'

Response Example

200
{"versionId": "ver-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "expectedChecksum": "abc123def456", "providedChecksum": "abc123def456", "match": true, "message": "Checksum matches, artifact is intact"}

Change History

This API has no change history records yet.

View all change history