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

ListUpdates

List available software updates and their installation status

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • typeString

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

  • severityString

    Filter updates by severity level

  • limitInteger

    Maximum number of results to return

    Example: 0

  • offsetInteger

    Number of results to skip for pagination

    Example: 0

  • statusString

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

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • uuidString

      Unique identifier of this discovered update package

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

    • nameString

      Name of the update package

      Example: zcf-security-patch

    • versionString

      Version of the update package

      Example: 1.3.1

    • typeString

      Category type of this update package

      Example: security

    • severityString

      Urgency severity level of this update

      Example: critical

    • descriptionString

      Description of what this update addresses

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

    • sizeString

      Size of the update package in bytes

      Example: 10485760

    • checksumString

      SHA256 or other checksum for integrity verification

      Example: sha256:abc123

    • downloadUrlString

      URL from which this update package can be downloaded

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

    • downloadedBoolean

      Whether this update has already been downloaded locally

      Example: false

    • discoveredAtString

      Discovered at

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

    • createDateString

      Create date

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

    • lastOpDateString

      Last op date

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

    • statusString

      Status for this resource

      Example: running

    • componentTypeString

      Component type

      Example: "lifecycle-service"

    • deployedVersionString

      Deployed version

      Example: 1.2.0

    • releaseString

      Target release

      Example: 221

    • deployedReleaseString

      Deployed release

      Example: 215

    • changelogString

      Changelog for this resource

      Example: "Bug fixes and performance improvements"

    • releaseDateString

      Release date

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

  • totalInteger

    Total number of update packages matching the query

    Example: 4

  • 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/updates

/api/v1/lifecycle/updates

Operation ID

ListUpdates

Permalink

Request Example

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

Response Example

200
{"items": [{"uuid": "upd-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "zcf-security-patch", "version": "1.3.1", "type": "security", "severity": "critical", "description": "Patches CVE-2026-12345 in the authentication module", "size": 10485760, "checksum": "sha256:abc123"}], "total": 4, "limit": 20, "offset": 20}

Change History

This API has no change history records yet.

View all change history