Skip to main content
ZStack
Platform Operations/Platform Misc

ListAPIVersions

List all supported API versions with their lifecycle status and sunset dates.

GET/api/v1/versions

Operation ID

ListAPIVersions

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

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    List of API version entries

    Example: (nested array)

    • version
      String

      API version string (e.g. v1, v2)

      Example: v1

    • status
      String

      Lifecycle status of this API version (stable, deprecated, sunset)

      Example: stable

    • sunsetDate
      String

      Date when this API version will be sunset (ISO 8601)

      Example: 2026-12-31

    • changelogUrl
      String

      URL to the changelog for this version

      Example: https://docs.example.com/changelog/v1

  • total
    Integer

    Total number of versions

    Example: 2

  • limit
    Integer

    Maximum number of items per page

    Example: 20

  • offset
    Integer

    Number of items skipped

    Example: 20