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

# Set control plane self-heal

> Turns the automatic restart of a NotReady control plane on or off for this cluster (`ankra cluster control-plane-heal enable|disable`). While it is on, Ankra restarts a control plane through the cloud provider when it has been NotReady for about ten minutes, every other control plane is Ready, and etcd keeps its quorum without it; it never stops, deprovisions or scales anything, and shows each restart and its outcome in the cluster's notifications and audit log. Turning it off leaves a NotReady control plane for you to handle. Every change is recorded in the organisation's audit log; re-sending the current value changes nothing. Requires `clusters.write` on the cluster.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json put /api/v1/org/clusters/{cluster_id}/control-plane-self-heal
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - 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: 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: 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: 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: 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: 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: Account
    description: >-
      Your own account: the contact email Ankra mails when it differs from your
      sign-in address.
  - 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: 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: 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: Support
    description: Support tickets.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /api/v1/org/clusters/{cluster_id}/control-plane-self-heal:
    put:
      tags:
        - Clusters
      summary: Set control plane self-heal
      description: >-
        Turns the automatic restart of a NotReady control plane on or off for
        this cluster (`ankra cluster control-plane-heal enable|disable`). While
        it is on, Ankra restarts a control plane through the cloud provider when
        it has been NotReady for about ten minutes, every other control plane is
        Ready, and etcd keeps its quorum without it; it never stops,
        deprovisions or scales anything, and shows each restart and its outcome
        in the cluster's notifications and audit log. Turning it off leaves a
        NotReady control plane for you to handle. Every change is recorded in
        the organisation's audit log; re-sending the current value changes
        nothing. Requires `clusters.write` on the cluster.
      operationId: >-
        set_control_plane_self_heal_api_v1_org_clusters__cluster_id__control_plane_self_heal_put
      parameters:
        - description: PAT organisation override.
          in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            type: string
        - name: cluster_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ControlPlaneSelfHealRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ControlPlaneSelfHealView'
          description: Successful response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Missing or malformed Authorization header
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Unknown, expired, or revoked API token
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: >-
            Permission check failed (`clusters.write`), or the token may not use
            this surface
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Cluster not found in the token's organisation
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: 'Request validation error: `enabled` is missing or not a boolean'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Internal server error
      security:
        - BearerAuth: []
components:
  schemas:
    ControlPlaneSelfHealRequest:
      description: >-
        Turns the automatic restart of a NotReady control plane on or off for
        one cluster.
      example:
        enabled: true
      properties:
        enabled:
          description: >-
            Whether Ankra may restart a NotReady control plane of this cluster
            through its cloud provider. Must be a real boolean.
          type: boolean
      required:
        - enabled
      type: object
    ControlPlaneSelfHealView:
      description: >-
        A cluster's control-plane self-heal switch and its latest NotReady
        episode.
      example:
        cluster_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        enabled: true
        latest_incident: null
      properties:
        cluster_id:
          type: string
          format: uuid
        enabled:
          description: The stored switch. On for every cluster until a member turns it off.
          type: boolean
        latest_incident:
          anyOf:
            - $ref: '#/components/schemas/ControlPlaneSelfHealIncident'
            - type: 'null'
          description: >-
            The most recent NotReady episode; null when the cluster never had
            one.
      required:
        - cluster_id
        - enabled
        - latest_incident
      type: object
    ContractDetailError:
      example:
        detail: Cluster not found
      properties:
        detail:
          oneOf:
            - type: string
            - additionalProperties: true
              properties: {}
              type: object
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ControlPlaneSelfHealIncident:
      description: One NotReady episode of a control plane, as Ankra saw and handled it.
      example:
        node_name: cp-1
        state: closed
        outcome: restored
        reason: the node is Ready and every etcd voter is serving
        restart_attempts: 1
        not_ready_since: '2026-10-13T08:02:00Z'
        last_restart_at: '2026-10-13T08:14:30Z'
        closed_at: '2026-10-13T08:19:10Z'
        mode: active
      properties:
        node_name:
          description: The Kubernetes node name of the control plane.
          type: string
        state:
          description: open, probing, rebooting, verifying or closed.
          type: string
        outcome:
          description: >-
            How a closed episode ended: restored, restored_etcd_unconfirmed,
            recovered_unaided, node_gone or cluster_gone. Empty while the
            episode is open.
          type: string
        reason:
          description: >-
            While open, why Ankra is not restarting the node yet; once closed,
            how it ended.
          type: string
        restart_attempts:
          description: Provider restarts Ankra issued during this episode.
          type: integer
        not_ready_since:
          description: When the node last became NotReady, from the node's Ready condition.
          format: date-time
          type: string
        last_restart_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: When Ankra last restarted the node's server; null when it never did.
        closed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: When the episode ended; null while it is open.
        mode:
          description: >-
            shadow when the platform only recorded what it would have done,
            active when it was allowed to restart the server.
          type: string
      required:
        - node_name
        - state
        - outcome
        - reason
        - restart_attempts
        - not_ready_since
        - last_restart_at
        - closed_at
        - mode
      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
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````

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