Skip to main content
API Explorer|API Explorer
Infrastructure/OTA Upgrade Plans
GETOTASince 1.0SynchronousAuth Required

ListHistory

List historical upgrade execution records and their outcomes

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • planIdString

    Filter history by plan ID

  • componentString

    Filter history by component name

  • statusString

    Filter history by status

  • limitInteger

    Maximum number of results to return

    Example: 0

  • offsetInteger

    Number of results to skip for pagination

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • uuidString

      Unique identifier for this upgrade history record

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

    • planIdString

      ID of the plan this history entry is associated with

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

    • planNameString

      Name of the upgrade plan at the time of execution

      Example: Upgrade agents to v1.3.0

    • fromVersionString

      Version upgraded from

      Example: 1.2.0

    • toVersionString

      Version upgraded to

      Example: 1.3.0

    • fromReleaseString

      Release upgraded from

      Example: 215

    • toReleaseString

      Release upgraded to

      Example: 221

    • componentString

      Component that was upgraded

      Example: zcf-core

    • statusString

      Final status of this upgrade operation

      Example: completed

    • resultString

      Outcome result of the upgrade

      Example: success

    • logsString

      The logs value

      Example: value

    • startedAtString

      Started at

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

    • completedAtString

      Completed at

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

    • operatorString

      Operator who triggered this upgrade

      Example: admin

    • createDateString

      Create date

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

  • totalInteger

    Total number of history entries matching the query

    Example: 15

  • limitInteger

    Maximum number of items returned per page

    Example: 20

  • offsetInteger

    Number of items skipped before the current page

    Example: 20

Endpoint

GET/api/v1/lifecycle/upgrade-history

/api/v1/lifecycle/upgrade-history

Operation ID

ListHistory

Permalink

Request Example

curl -X GET '{host}/api/v1/lifecycle/upgrade-history' -H 'Authorization: Bearer {token}'

Response Example

200
{"items": [{"uuid": "hist-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "planId": "plan-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "planName": "Upgrade agents to v1.3.0", "fromVersion": "1.2.0", "toVersion": "1.3.0", "fromRelease": "215", "toRelease": "221", "component": "zcf-core"}], "total": 15, "limit": 20, "offset": 20}

Change History

This API has no change history records yet.

View all change history