ListGraduatedPlans

On success, this API returns the following response structure.

• items

  List

  Collection of result items

  Example: (nested array)

  Show child properties
  • id

    String

    Unique identifier of the graduated upgrade plan

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

  • name

    String

    Human-readable name of the upgrade plan

    Example: Upgrade agents to v1.3.0

  • fromVersion

    String

    Source version agents will be upgraded from

    Example: 1.2.0

  • toVersion

    String

    Target version agents will be upgraded to

    Example: 1.3.0

  • fromRelease

    String

    Source release agents will be upgraded from

    Example: 215

  • toRelease

    String

    Target release agents will be upgraded to

    Example: 221

  • batches

    List

    Batches for this resource

    Example: (nested array)

    Show child properties
    • batchIndex

      Integer

      Zero-based index of this batch in the graduated upgrade plan

      Example: 20

    • agentIds

      List

      Agent ids

      Example: item1,item2

    • status

      String

      Current execution status of this batch

      Example: completed

    • failedCount

      Integer

      Number of agents in this batch that failed the upgrade

      Example: 20

    • tasks

      List

      Runtime-targeted tasks in this batch

      Example: (nested array)

      Show child properties
      • componentUuid

        String

        UUID of the managed component this task belongs to

        Example: abcdef0123456789abcdef0123456789

      • componentInstanceUuid

        String

        UUID of the runtime component instance this task targets

        Example: abcdef0123456789abcdef0123456789

      • lifecycleTaskUuid

        String

        UUID of the lifecycle task executing this plan task

        Example: task-a1b2c3d4

      • componentName

        String

        Component name

        Example: zmetis

      • taskType

        String

        Lifecycle task type

        Example: update

      • status

        String

        Plan task status

        Example: running

      • nodeUuid

        String

        UUID of the node hosting the runtime component instance

        Example: abcdef0123456789abcdef0123456789

      • lcaUuid

        String

        Stable UUID of the LCA owning the runtime component instance

        Example: abcdef0123456789abcdef0123456789

      • runtimeStatus

        String

        Last reported runtime status of the component instance

        Example: running

      • actualVersion

        String

        Last reported runtime version of the component instance

        Example: 1.0.0

      • actualRelease

        String

        Last reported runtime release of the component instance

        Example: 221

  • failureThreshold

    Long

    Maximum fraction of failed upgrades before the plan is auto-paused

    Example: 0.1

  • concurrency

    Integer

    Maximum number of agents upgraded concurrently within a batch

    Example: 5

  • status

    String

    Current execution status of the graduated plan

    Example: running

  • currentBatch

    Integer

    Index of the batch currently being executed

    Example: 1

  • createdBy

    String

    Username or ID of the operator who created this plan

    Example: admin

  • createdAt

    String

    Created at

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

  • startedAt

    String

    Started at

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

  • pausedAt

    String

    Paused at

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

  • pauseReason

    String

    Reason the plan was paused, if applicable

    Example: Failure threshold exceeded

  • completedAt

    String

    Completed at

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

  • sourcePlanUuid

    String

    Source plan uuid

    Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

  • error

    String

    Error details returned when stream processing fails

    Example: "upgrade failed: timeout"

  • observeDuration

    String

    Observe duration

    Example: value

• total

  Integer

  Total number of graduated plans matching the query

  Example: 3

• limit

  Integer

  Maximum number of items returned per page

  Example: 20

• offset

  Integer

  Number of items skipped before the current page

  Example: 20