> ## 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.

# Change Control Plane Instance Type Endpoint



## OpenAPI

````yaml https://platform.ankra.app/openapi.json put /api/v1/clusters/hetzner/{cluster_id}/control-plane/instance-type
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - 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: 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: Kubernetes
    description: Read and act on the Kubernetes objects inside a 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: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - 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 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 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: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - 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: OVH Credentials
    description: OVH credentials and SSH keys.
  - 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: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - 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: Support
    description: Support tickets.
paths:
  /api/v1/clusters/hetzner/{cluster_id}/control-plane/instance-type:
    put:
      tags:
        - Hetzner Clusters
      summary: Change Control Plane Instance Type Endpoint
      operationId: >-
        change_control_plane_instance_type_endpoint_api_v1_clusters_hetzner__cluster_id__control_plane_instance_type_put
      parameters:
        - in: path
          name: cluster_id
          required: true
          schema:
            format: uuid
            title: Cluster Id
            type: string
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Ankra-Organisation-Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeControlPlaneInstanceTypeRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeControlPlaneInstanceTypeResult'
          description: Successful Response
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    ChangeControlPlaneInstanceTypeRequest:
      properties:
        force_drain:
          default: false
          description: >-
            Rolling lane only. Bypass PodDisruptionBudgets when draining each
            controller. Off by default: a PDB is a workload owner's stated
            availability requirement.
          title: Force Drain
          type: boolean
        instance_type:
          description: >-
            The new instance type for every control plane node. On a stopped
            cluster it is applied at the next start; on a running cluster with
            at least three controllers it is rolled out live, one controller at
            a time, each drained and waited back to healthy before the next.
          minLength: 1
          title: Instance Type
          type: string
      required:
        - instance_type
      title: ChangeControlPlaneInstanceTypeRequest
      type: object
    ChangeControlPlaneInstanceTypeResult:
      properties:
        mode:
          description: >-
            Which lane the request took: 'offline' rewrote a stopped cluster's
            plan, 'rolling' is the live one-controller-at-a-time path on a
            running cluster. It describes the lane, not whether work was
            dispatched - read operation_id for that.
          enum:
            - offline
            - rolling
          title: Mode
          type: string
        new_instance_type:
          title: New Instance Type
          type: string
        operation_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: >-
            The operation to poll, when the request dispatched one. Null
            whenever nothing was dispatched: on the offline lane, which applies
            the new size at the next cluster start (its own operation), and on
            either lane when the control planes already run the requested type
            (updated is 0). Decide whether to poll by testing operation_id for
            null, not by reading mode.
          title: Operation Id
        previous_instance_type:
          title: Previous Instance Type
          type: string
        updated:
          title: Updated
          type: integer
      required:
        - previous_instance_type
        - new_instance_type
        - updated
        - mode
      title: ChangeControlPlaneInstanceTypeResult
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object

````