Skip to main content
ZStack
Infrastructure/OTA Upgrade Plans

ListUpdates

List available software updates and their installation status

GET/api/v1/lifecycle/updates

Operation ID

ListUpdates

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

  • type
    String

    Filter updates by type, e.g. security, feature, bugfix

  • severity
    String

    Filter updates by severity level

  • limit
    Integer

    Maximum number of results to return

    Example: 0

  • offset
    Integer

    Number of results to skip for pagination

    Example: 0

  • status
    String

    P2a: filter by status (discovered/downloaded/applied/obsolete); empty = exclude obsolete Status

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 of this discovered update package

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

    • name
      String

      Name of the update package

      Example: zcf-security-patch

    • version
      String

      Version of the update package

      Example: 1.3.1

    • type
      String

      Category type of this update package

      Example: security

    • severity
      String

      Urgency severity level of this update

      Example: critical

    • description
      String

      Description of what this update addresses

      Example: Patches CVE-2026-12345 in the authentication module

    • size
      String

      Size of the update package in bytes

      Example: 10485760

    • checksum
      String

      SHA256 or other checksum for integrity verification

      Example: sha256:abc123

    • downloadUrl
      String

      URL from which this update package can be downloaded

      Example: https://depot.example.com/updates/zcf-security-patch-1.3.1.tar.gz

    • downloaded
      Boolean

      Whether this update has already been downloaded locally

      Example: false

    • discoveredAt
      String

      Discovered at

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

    • createDate
      String

      Create date

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

    • lastOpDate
      String

      Last op date

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

    • status
      String

      Status for this resource

      Example: running

    • componentType
      String

      Component type

      Example: "lifecycle-service"

    • deployedVersion
      String

      Deployed version

      Example: 1.2.0

    • release
      String

      Target release

      Example: 221

    • deployedRelease
      String

      Deployed release

      Example: 215

    • changelog
      String

      Changelog for this resource

      Example: "Bug fixes and performance improvements"

    • releaseDate
      String

      Release date

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

  • total
    Integer

    Total number of update packages matching the query

    Example: 4

  • limit
    Integer

    Maximum number of items returned per page

    Example: 20

  • offset
    Integer

    Number of items skipped before the current page

    Example: 20