Skip to main content
POST
Move a cluster to another zone

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id
string<uuid>
required

The source cluster: the one being moved.

Body

application/json

A zone move start. zone is required unless target_cluster_id names an existing cluster to move into.

zone
string

The Ankra Cloud zone to move to, such as se-sto1.

target_cluster_id
string<uuid>

An existing Ankra Cloud cluster to move into: same organisation, online, holding none of the source's stack names. Skips provisioning.

target_name
string

The new cluster's name; default -.

plan_only
boolean
default:false

Compute and answer the plan; write nothing.

control_plane_count
integer

Overrides the derived control plane count (odd).

control_plane_plan
string

Overrides the derived control plane plan.

worker_plan
string

Overrides every node group's plan.

worker_count
integer

Overrides every node group's count.

storage_tier
enum<string>

The tier the restored volumes and the target's disks land on; default standard (Ankra Storage). The source's ankra-default and ankra-local-nvme classes map onto this tier's class.

Available options:
local-nvme,
standard,
maxiops,
hdd
soak_days
integer

How long the paused source is kept for a rollback; default 7.

Required range: 1 <= x <= 30
vault
string

The backup vault, by name or id, every data copy of the move writes its restore point to (the seed's and the final copy's). Default: each stack's own backup policy vault, else the organisation's only ready vault. With several ready vaults and neither, plan_only lists the stack's data under not_carried and the start answers 422.

Response

The plan (plan_only). Nothing was written.

move
object
required

A zone move. id and run_id are null on a plan_only answer.