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

GetCompatibilityMatrix

Get Compatibility Matrix

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • fromVersionString

    Source version to check upgrade compatibility from

  • toVersionString

    Target version to check upgrade compatibility to

Responses

200 OK

On success, this API returns the following response structure.

  • fromVersionString

    Source version being evaluated for upgrade compatibility

    Example: 1.2.0

  • toVersionString

    Target version being evaluated for upgrade compatibility

    Example: 1.3.0

  • compatibleBoolean

    Whether a direct upgrade from from_version to to_version is supported

    Example: true

  • reasonString

    Human-readable explanation of the compatibility determination

    Example: Direct upgrade is supported

  • upgradePathList

    Upgrade path

    Example: item1,item2

Endpoint

GET/api/v1/ota/versions/compatibility

/api/v1/ota/versions/compatibility

Operation ID

GetCompatibilityMatrix

Permalink

Request Example

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

Response Example

200
{"fromVersion": "1.2.0", "toVersion": "1.3.0", "compatible": true, "reason": "Direct upgrade is supported", "upgradePath": ["value"]}

Change History

This API has no change history records yet.

View all change history