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

GetHistoryLogs

Retrieve detailed execution logs for a historical upgrade record

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 upgrade history entry to retrieve logs for

Responses

200 OK

On success, this API returns the following response structure.

  • 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

Endpoint

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

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

Operation ID

GetHistoryLogs

Permalink

Request Example

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

Response Example

200
{"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"}

Change History

This API has no change history records yet.

View all change history