Skip to main content
Infrastructure/OTA Upgrade Plans

GetHistoryLogs

Retrieve detailed execution logs for a historical upgrade record

GET/api/v1/lifecycle/upgrade-history/{id}/logs

Operation ID

GetHistoryLogs

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

Path Parameters

  • id
    StringRequired

    ID of the upgrade history entry to retrieve logs for

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • 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