Skip to main content
ZStack
Infrastructure/OTA Upgrade Plans

ListHistory

List historical upgrade execution records and their outcomes

GET/api/v1/lifecycle/upgrade-history

Operation ID

ListHistory

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

Query Parameters

  • planId
    String

    Filter history by plan ID

  • component
    String

    Filter history by component name

  • status
    String

    Filter history by status

  • limit
    Integer

    Maximum number of results to return

    Example: 0

  • offset
    Integer

    Number of results to skip for pagination

    Example: 0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • uuid
      String

      Unique identifier for this upgrade history record

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

    • planId
      String

      ID of the plan this history entry is associated with

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

    • planName
      String

      Name of the upgrade plan at the time of execution

      Example: Upgrade agents to v1.3.0

    • fromVersion
      String

      Version upgraded from

      Example: 1.2.0

    • toVersion
      String

      Version upgraded to

      Example: 1.3.0

    • fromRelease
      String

      Release upgraded from

      Example: 215

    • toRelease
      String

      Release upgraded to

      Example: 221

    • component
      String

      Component that was upgraded

      Example: zcf-core

    • status
      String

      Final status of this upgrade operation

      Example: completed

    • result
      String

      Outcome result of the upgrade

      Example: success

    • logs
      String

      The logs value

      Example: value

    • startedAt
      String

      Started at

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

    • completedAt
      String

      Completed at

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

    • operator
      String

      Operator who triggered this upgrade

      Example: admin

    • createDate
      String

      Create date

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

  • total
    Integer

    Total number of history entries matching the query

    Example: 15

  • limit
    Integer

    Maximum number of items returned per page

    Example: 20

  • offset
    Integer

    Number of items skipped before the current page

    Example: 20