> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Move a cluster to another zone

> Plans a zone move of an Ankra Cloud cluster and, unless plan_only is true, starts it: the target is created (or the existing target_cluster_id is used), the stacks whose data lives on volumes are copied onto it as drafts with their volumes as a rehearsal, and the move waits in ready_for_cutover. Nothing on the target runs until the cutover. plan_only answers 200 with the plan and writes nothing. Requires stacks.read on the source; a start also needs stacks.write and clusters.operate on the source, backups.operate, and clusters.create unless target_cluster_id is given.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/org/clusters/imported/{cluster_id}/zone-move
openapi: 3.1.0
info:
  title: Ankra Platform API
  version: v1
  description: >-
    The Ankra platform HTTP contract. The /api/v1 surface is the public,
    bearer-authenticated API used by the Ankra CLI, MCP clients and automation;
    send a personal or service API token as `Authorization: Bearer <token>`.
    Browser routes under /org and /chat are served on api.platform.ankra.app
    (each declares that server); they and /oauth/access authenticate with the
    ankra_session cookie, and mutations also require the X-Ankra-CSRF header.
    Every operation declares the credential it accepts. Only the public platform
    status feed (GET /api/v1/status) is served without one. This document is
    published deliberately: it describes the contract only and carries no
    organisation data or credentials. Report security issues to
    security@ankra.ai (see /.well-known/security.txt).
servers:
  - url: https://platform.ankra.app
security:
  - BearerAuth: []
tags:
  - name: Onboarding
    description: >-
      Generate a first website from a prompt and deploy it to a new
      organisation's cluster.
  - name: Access Gate
    description: >-
      Private service sign-in and membership checks for trusted Ankra proxy
      relays.
  - name: Canvas Datasets
    description: >-
      Read the fixed, named datasets canvas dashboards bind their charts, tables
      and stats to.
  - name: Canvases
    description: >-
      Keep dashboards and pages in the organisation's canvas library, with
      revision history, undo and pins.
  - name: Canvas Pages
    description: >-
      Publish a chat canvas artifact at a public pages address and take it down
      again.
  - name: Cloud Delegation
    description: >-
      Platform browser consent and organisation-bound connections for Ankra
      Cloud.
  - name: Organisation IAM
    description: >-
      Custom organisation roles and scoped role assignments for member and
      service-account identities.
  - name: Clusters
    description: Create, inspect and manage clusters, and the stacks deployed on them.
  - name: Managed Clusters
    description: Provider-managed control planes, driven through one common surface.
  - name: Playground
    description: >-
      The organisation's playground cluster: order one, read its provisioning
      status, list the orderable sizes, resize it and destroy it.
  - name: Imported Clusters
    description: Clusters that already existed and were connected to Ankra.
  - name: Cluster Access
    description: Kubeconfigs, service-account tokens and per-cluster access grants.
  - name: Cluster Meshes
    description: >-
      Cilium ClusterMeshes that join an organisation's clusters into one
      network: create a mesh, check whether clusters can join, prepare a running
      cluster, and add or remove members.
  - name: Kubernetes
    description: Read and act on the Kubernetes objects inside a cluster.
  - name: AWS Clusters
    description: >-
      Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in
      your own VPC.
  - name: Ankra Cloud Clusters
    description: >-
      Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud
      servers: a private network, a NAT router and a bastion per cluster.
  - name: DigitalOcean Clusters
    description: Provision and manage DigitalOcean Kubernetes clusters.
  - name: Hetzner Clusters
    description: Provision and manage Hetzner Kubernetes clusters.
  - name: OVH Clusters
    description: Provision and manage OVH Kubernetes clusters.
  - name: Scaleway Clusters
    description: Provision and manage Scaleway Kapsule clusters.
  - name: UpCloud Clusters
    description: Provision and manage UpCloud Kubernetes clusters.
  - name: Proxmox Clusters
    description: >-
      Self-managed Kubernetes clusters Ankra builds on Proxmox VE VMs: the node,
      storage, bridge, template and size catalogs, create and teardown, start
      and stop, node groups, nodes, standalone VMs, upgrades and the bastion.
  - name: HPE Morpheus Clusters
    description: >-
      Self-managed Kubernetes clusters Ankra builds on HPE Morpheus VMs: the
      group, cloud, plan, layout and network catalogs, create and teardown,
      start and stop, node groups, nodes, standalone VMs, upgrades and the
      bastion.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Pipelines
    description: >-
      Pipeline definitions, the approval of the authority they declare, and the
      caches pipelines keep between runs.
  - name: Workspaces
    description: >-
      Personal workspaces on the organisation's CI pool where a repository's
      heavy commands run, and the repository profiles they are built from.
  - name: Deploy Targets
    description: >-
      Environments, the hosts registered to receive deployments, and the
      releases deployed to them.
  - name: Deploy Provenance
    description: >-
      Whether an application's deploys verify signed provenance from the
      organisation's own pipeline, the keys that provenance is signed with, and
      a dry-run that verifies images without deploying.
  - name: Backups
    description: >-
      Backup vaults, restore points, protection posture and captures for stacks
      and application deployments; a completed capture is not a verified
      restore.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - name: Services
    description: >-
      Versioned service packages and explicit sharing. Runtime admission is
      separate from publication.
  - name: Charts
    description: Browse the chart catalogue behind stacks and addons.
  - name: Helm
    description: Helm registries, credentials and the charts they expose.
  - name: Executions
    description: Long-running platform executions and their jobs.
  - name: Operations
    description: Cancel in-flight cluster operations and their jobs.
  - name: Chat
    description: Conversational sessions, plans and confirmable actions.
  - name: AI Management
    description: >-
      Customer agent lifecycle, authenticated identity and organisation
      automation controls.
  - name: AI Agent Runs
    description: Autonomous agent runs and their outcomes.
  - name: AI Tickets
    description: The AI ticket board, its sync connections and settings.
  - name: AI Playbooks
    description: Reusable playbooks the AI lanes execute.
  - name: AI Conditions
    description: Conditions that gate AI autonomy.
  - name: AI Remediation
    description: >-
      The organisation's auto-remediation policy: what the AI lanes may fix by
      themselves, and who approves the rest.
  - name: AI Engineering Handoffs
    description: Work the AI lanes escalate to a human engineer.
  - name: AI Environment
    description: The environment and base stacks AI demos deploy into.
  - name: AI Memory
    description: >-
      What the assistant has learned about you: your cross-session memories and
      learned profile.
  - name: MCP Servers
    description: >-
      Register the MCP servers the organisation's AI agents can call, choose
      their tools and grant them to roles.
  - name: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Decisions
    description: >-
      The decision ledger behind the Security and Cost queues: proposals a
      surface computed, the approve and set-aside decisions people took on them,
      and the receipts of running them.
  - name: Usage
    description: >-
      What your organisation used of Ankra - vCPU-hours, playgrounds, managed
      services, hosted logs and metrics, and AI - per meter and period, with how
      completely it was measured and whether a published rate applies.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Projects
    description: >-
      Projects group an organisation's clusters, applications, credentials and
      other resources beneath it: list, create, rename and delete them, switch
      the current project, see who reaches one, and move resources between them.
  - name: Account
    description: >-
      Your own account: the contact email Ankra mails when it differs from your
      sign-in address, and the AI provider keys your own work runs on.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - name: AWS Credentials
    description: >-
      AWS credentials: access keys or CloudFormation-onboarded STS roles for
      cost, EKS and self-managed provisioning.
  - name: Ankra Cloud Credentials
    description: >-
      Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud
      lanes.
  - name: Azure Credentials
    description: Azure credentials and SSH keys.
  - name: DigitalOcean Credentials
    description: DigitalOcean credentials and SSH keys.
  - name: Hetzner Credentials
    description: Hetzner credentials and SSH keys.
  - name: HPE Morpheus Credentials
    description: HPE Morpheus credentials and the capacity and quotas behind them.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Proxmox Credentials
    description: Proxmox VE credentials and the capacity and quotas behind them.
  - name: Scaleway Credentials
    description: Scaleway credentials.
  - name: UpCloud Credentials
    description: UpCloud credentials and SSH keys.
  - name: Data Source Credentials
    description: Credentials for metrics and log sources.
  - name: DNS Credentials
    description: Credentials for DNS providers.
  - name: Object Storage Buckets
    description: >-
      Buckets Ankra creates and manages on an organisation's own provider
      credentials.
  - name: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Avura
    description: >-
      The linked Avura organization, the domains it shares with Ankra Platform,
      and their DNS records.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: Secret Slots
    description: >-
      Store secrets in Vault and reference them by ${SECRET_SLOT:<slot_id>}
      sentinel instead of by value.
  - name: SOPS
    description: Encrypt and decrypt values with the organisation SOPS config.
  - name: Alerts
    description: Alert integrations and ingest credentials.
  - name: Notifications
    description: Notification routes and their delivery targets.
  - name: Platform Status
    description: >-
      The public status of the Ankra platform: incidents and maintenance Ankra
      staff publish, as shown on ankra.ai/status.
  - name: Support
    description: Support tickets.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /api/v1/org/clusters/imported/{cluster_id}/zone-move:
    post:
      tags:
        - Ankra Cloud Clusters
      summary: Move a cluster to another zone
      description: >-
        Plans a zone move of an Ankra Cloud cluster and, unless plan_only is
        true, starts it: the target is created (or the existing
        target_cluster_id is used), the stacks whose data lives on volumes are
        copied onto it as drafts with their volumes as a rehearsal, and the move
        waits in ready_for_cutover. Nothing on the target runs until the
        cutover. plan_only answers 200 with the plan and writes nothing.
        Requires stacks.read on the source; a start also needs stacks.write and
        clusters.operate on the source, backups.operate, and clusters.create
        unless target_cluster_id is given.
      operationId: start_zone_move_api_v1
      parameters:
        - in: path
          name: cluster_id
          required: true
          schema:
            type: string
            format: uuid
          description: 'The source cluster: the one being moved.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZoneMoveRequest'
      responses:
        '200':
          description: The plan (plan_only). Nothing was written.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneMoveEnvelope'
        '202':
          description: The move, started.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoneMoveEnvelope'
        '400':
          description: >-
            The source is not an Ankra Cloud cluster, the zone is unknown, or
            the target is the source or not an Ankra Cloud cluster; or the
            target's provider refused the create.
        '401':
          description: Not authenticated.
        '403':
          description: A required permission is not held.
        '404':
          description: Cluster not found.
        '409':
          description: A zone move of this cluster is already in progress.
        '422':
          description: >-
            The body is invalid, the target cannot take the move (not found, not
            online, already holding the source's stack names), or the plan was
            refused (an invalid count, soak or storage tier).
        '500':
          description: Internal error.
      security:
        - BearerAuth: []
components:
  schemas:
    ZoneMoveRequest:
      type: object
      description: >-
        A zone move start. zone is required unless target_cluster_id names an
        existing cluster to move into.
      properties:
        zone:
          type: string
          description: The Ankra Cloud zone to move to, such as se-sto1.
        target_cluster_id:
          type: string
          format: uuid
          description: >-
            An existing Ankra Cloud cluster to move into: same organisation,
            online, holding none of the source's stack names. Skips
            provisioning.
        target_name:
          type: string
          description: The new cluster's name; default <source name>-<zone>.
        plan_only:
          type: boolean
          default: false
          description: Compute and answer the plan; write nothing.
        control_plane_count:
          type: integer
          description: Overrides the derived control plane count (odd).
        control_plane_plan:
          type: string
          description: Overrides the derived control plane plan.
        worker_plan:
          type: string
          description: Overrides every node group's plan.
        worker_count:
          type: integer
          description: Overrides every node group's count.
        storage_tier:
          type: string
          enum:
            - local-nvme
            - standard
            - maxiops
            - hdd
          description: >-
            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.
        soak_days:
          type: integer
          minimum: 1
          maximum: 30
          description: How long the paused source is kept for a rollback; default 7.
        vault:
          type: string
          description: >-
            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.
    ZoneMoveEnvelope:
      type: object
      required:
        - move
      properties:
        move:
          $ref: '#/components/schemas/ZoneMove'
    ZoneMove:
      type: object
      description: A zone move. id and run_id are null on a plan_only answer.
      required:
        - id
        - source_cluster_id
        - target_cluster_id
        - zone
        - status
        - plan
        - steps
        - soak_until
        - created_at
        - updated_at
      properties:
        id:
          type:
            - string
            - 'null'
          format: uuid
        run_id:
          type:
            - string
            - 'null'
          format: uuid
          description: The move's run in /org/runs.
        source_cluster_id:
          type: string
          format: uuid
        target_cluster_id:
          type:
            - string
            - 'null'
          format: uuid
        zone:
          type: string
        status:
          type: string
          enum:
            - planned
            - provisioning
            - seeding
            - ready_for_cutover
            - freezing
            - final_copy
            - cutting_over
            - soaking
            - rolling_back
            - rolled_back
            - retiring
            - retired
            - failed
        plan:
          $ref: '#/components/schemas/ZoneMovePlan'
        steps:
          type: array
          items:
            $ref: '#/components/schemas/ZoneMoveStep'
        soak_until:
          type:
            - string
            - 'null'
          format: date-time
        error_excerpt:
          type:
            - string
            - 'null'
          description: Why a failed move stopped.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ZoneMovePlan:
      type: object
      required:
        - target
        - stacks
        - data
        - not_carried
        - dns
      properties:
        target:
          type: object
          properties:
            name:
              type: string
            zone:
              type: string
            network_mode:
              type: string
            storage_tier:
              type: string
            control_plane:
              type: object
              properties:
                plan:
                  type: string
                count:
                  type: integer
            bastion_plan:
              type: string
            node_groups:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  plan:
                    type: string
                  count:
                    type: integer
            existing_cluster_id:
              type: string
        stacks:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              carried:
                type: boolean
              reason:
                type:
                  - string
                  - 'null'
              namespaces:
                type: array
                items:
                  type: string
              seeded:
                type: boolean
              stopped_with_source:
                type: boolean
                description: >-
                  Not carried, but put in standby with the source's writers: the
                  source's external-dns, which would write the moved names back.
              vault:
                type: object
                description: >-
                  The backup vault a carried stack's data copies write their
                  restore point to, resolved as the copy resolves it. Absent for
                  a stack with no data, or whose vault cannot be resolved
                  (listed under not_carried instead).
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  basis:
                    type: string
                    enum:
                      - request
                      - stack_policy
                      - only_ready_vault
                    description: >-
                      What chose it: the request's vault, the stack's own backup
                      policy, or the organisation's only ready vault.
        data:
          type: array
          items:
            type: object
            properties:
              stack:
                type: string
              namespace:
                type: string
              name:
                type: string
              kind:
                type: string
              engine:
                type: string
              requested_bytes:
                type: integer
              storage_class:
                type: string
              target_storage_class:
                type: string
        not_carried:
          type: array
          items:
            type: object
            properties:
              what:
                type: string
              reason:
                type: string
        dns:
          type: array
          items:
            type: object
            properties:
              hostname:
                type: string
              mechanism:
                type: string
              source_origin:
                type: string
              target_origin:
                type:
                  - string
                  - 'null'
        storage_class_mapping:
          type: object
          additionalProperties:
            type: string
        load_balancers:
          type: array
          items:
            type: object
            properties:
              service:
                type: object
                properties:
                  namespace:
                    type: string
                  name:
                    type: string
              source_load_balancer_id:
                type: string
              target_load_balancer_id:
                type: string
        warnings:
          type: array
          items:
            type: string
    ZoneMoveStep:
      type: object
      required:
        - name
        - status
        - started_at
        - finished_at
        - message
      properties:
        name:
          type: string
        status:
          type: string
          enum:
            - pending
            - running
            - succeeded
            - failed
            - skipped
        started_at:
          type:
            - string
            - 'null'
          format: date-time
        finished_at:
          type:
            - string
            - 'null'
          format: date-time
        message:
          type: string
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.