CreateGraduatedPlan

On success, this API returns the following response structure.

• idString

  Unique identifier of the graduated upgrade plan

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

• nameString

  Human-readable name of the upgrade plan

  Example: Upgrade agents to v1.3.0

• fromVersionString

  Source version agents will be upgraded from

  Example: 1.2.0

• toVersionString

  Target version agents will be upgraded to

  Example: 1.3.0

• fromReleaseString

  Source release agents will be upgraded from

  Example: 215

• toReleaseString

  Target release agents will be upgraded to

  Example: 221

• batchesList

  Batches for this resource

  Example: (nested array)

  Show child properties

  • batchIndexInteger

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

    Example: 20

  • agentIdsList

    Agent ids

    Example: item1,item2

  • statusString

    Current execution status of this batch

    Example: completed

  • failedCountInteger

    Number of agents in this batch that failed the upgrade

    Example: 20

  • tasksList

    Runtime-targeted tasks in this batch

    Example: (nested array)

    Show child properties

    • componentUuidString

      UUID of the managed component this task belongs to

      Example: abcdef0123456789abcdef0123456789

    • componentInstanceUuidString

      UUID of the runtime component instance this task targets

      Example: abcdef0123456789abcdef0123456789

    • lifecycleTaskUuidString

      UUID of the lifecycle task executing this plan task

      Example: task-a1b2c3d4

    • componentNameString

      Component name

      Example: zmetis

    • taskTypeString

      Lifecycle task type

      Example: update

    • statusString

      Plan task status

      Example: running

    • nodeUuidString

      UUID of the node hosting the runtime component instance

      Example: abcdef0123456789abcdef0123456789

    • lcaUuidString

      Stable UUID of the LCA owning the runtime component instance

      Example: abcdef0123456789abcdef0123456789

    • runtimeStatusString

      Last reported runtime status of the component instance

      Example: running

    • actualVersionString

      Last reported runtime version of the component instance

      Example: 1.0.0

    • actualReleaseString

      Last reported runtime release of the component instance

      Example: 221

• failureThresholdLong

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

  Example: 0.1

• concurrencyInteger

  Maximum number of agents upgraded concurrently within a batch

  Example: 5

• statusString

  Current execution status of the graduated plan

  Example: running

• currentBatchInteger

  Index of the batch currently being executed

  Example: 1

• createdByString

  Username or ID of the operator who created this plan

  Example: admin

• createdAtString

  Created at

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

• startedAtString

  Started at

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

• pausedAtString

  Paused at

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

• pauseReasonString

  Reason the plan was paused, if applicable

  Example: Failure threshold exceeded

• completedAtString

  Completed at

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

• sourcePlanUuidString

  Source plan uuid

  Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

• errorString

  Error for this resource

  Example: "upgrade failed: timeout"

• observeDurationString

  Observe duration

  Example: value