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

# Remove a node from a node group

> Removes one named worker from its node group and lowers the group's count by one. `node` is the worker's node id, its server name, the name of the Kubernetes node it registered as, or the providerID that node reports, matched case-insensitively; escape the slashes of a providerID (`hcloud:%2F%2F168428300`). The worker is drained through its PodDisruptionBudgets from a surviving control plane and then deleted; if the drain is refused the worker stays in service, the group keeps its count, and the operation fails with the reason; ask for the same removal again once it is resolved. Pass `force_drain=true` to take the worker down on a cluster teardown's drain instead. Refused with 409: any removal while the cluster is stopped (start the cluster first), a control plane, a worker of another group, a worker already marked for deletion or whose server is stopping, the group's last node that has joined the cluster (scale the node group to 0 or delete it instead), a removal that would take an autoscaling group below its `min_count` (for both, a worker still being created or whose node never joined the cluster does not count), a name several nodes answer to, one already leaving included (the answer names each by its node id), a name the platform cannot resolve right now (a providerID while it has no current view of the cluster's nodes, or while a candidate's node reports no providerID or one another node shares; on AWS a node name it has not recorded yet), and a providerID the candidates' nodes cannot be matched with because they report only a `k3s://` placeholder, which a node keeps for good; name the node by its server name or node id instead. A node the node group does not have answers 404, a providerID none of the group's nodes reports included once every candidate's node reports its own, and a UUID that is no node's id even while an AWS node name is not recorded yet; a blank `node`, or a path segment that is not valid percent-encoding, answers 422. By default the change runs in the background and the call answers 202 `{"status": "accepted"}`, with the removed node, the counts and `operation_id` when the removal was decided within the request (409 if the same removal is already in flight; a refusal decided later is put on the cluster's operations list); pass `wait=true` to run it in the request and receive the result with 200. Requires `clusters.delete`.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json delete /api/v1/clusters/digitalocean/{cluster_id}/node-groups/{group_name}/nodes/{node}
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, and no operation 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: 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: 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: 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: Support
    description: Support tickets.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /api/v1/clusters/digitalocean/{cluster_id}/node-groups/{group_name}/nodes/{node}:
    delete:
      tags:
        - DigitalOcean Clusters
      summary: Remove a node from a node group
      description: >-
        Removes one named worker from its node group and lowers the group's
        count by one. `node` is the worker's node id, its server name, the name
        of the Kubernetes node it registered as, or the providerID that node
        reports, matched case-insensitively; escape the slashes of a providerID
        (`hcloud:%2F%2F168428300`). The worker is drained through its
        PodDisruptionBudgets from a surviving control plane and then deleted; if
        the drain is refused the worker stays in service, the group keeps its
        count, and the operation fails with the reason; ask for the same removal
        again once it is resolved. Pass `force_drain=true` to take the worker
        down on a cluster teardown's drain instead. Refused with 409: any
        removal while the cluster is stopped (start the cluster first), a
        control plane, a worker of another group, a worker already marked for
        deletion or whose server is stopping, the group's last node that has
        joined the cluster (scale the node group to 0 or delete it instead), a
        removal that would take an autoscaling group below its `min_count` (for
        both, a worker still being created or whose node never joined the
        cluster does not count), a name several nodes answer to, one already
        leaving included (the answer names each by its node id), a name the
        platform cannot resolve right now (a providerID while it has no current
        view of the cluster's nodes, or while a candidate's node reports no
        providerID or one another node shares; on AWS a node name it has not
        recorded yet), and a providerID the candidates' nodes cannot be matched
        with because they report only a `k3s://` placeholder, which a node keeps
        for good; name the node by its server name or node id instead. A node
        the node group does not have answers 404, a providerID none of the
        group's nodes reports included once every candidate's node reports its
        own, and a UUID that is no node's id even while an AWS node name is not
        recorded yet; a blank `node`, or a path segment that is not valid
        percent-encoding, answers 422. By default the change runs in the
        background and the call answers 202 `{"status": "accepted"}`, with the
        removed node, the counts and `operation_id` when the removal was decided
        within the request (409 if the same removal is already in flight; a
        refusal decided later is put on the cluster's operations list); pass
        `wait=true` to run it in the request and receive the result with 200.
        Requires `clusters.delete`.
      operationId: >-
        remove_node_group_node_api_v1_clusters_digitalocean__cluster_id__node_groups__group_name__nodes__node__delete
      parameters:
        - in: path
          name: cluster_id
          required: true
          schema:
            type: string
            format: uuid
            title: Cluster Id
        - in: path
          name: group_name
          required: true
          schema:
            title: Group Name
            type: string
        - description: >-
            The worker to remove: its node id, its server name, its Kubernetes
            node name, or the providerID its node reports with its slashes
            escaped as %2F. Matched case-insensitively.
          in: path
          name: node
          required: true
          schema:
            title: Node
            type: string
        - description: >-
            Take the worker down on a cluster teardown's drain, without
            honouring PodDisruptionBudgets. Off by default: the worker is
            drained through its budgets, and a refused drain keeps the worker
            and the group's count and fails the operation naming what refused
            it.
          in: query
          name: force_drain
          required: false
          schema:
            default: false
            title: Force Drain
            type: boolean
        - in: query
          name: wait
          required: false
          schema:
            default: false
            title: Wait
            type: boolean
        - 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveNodeGroupNodeResult'
          description: The worker is being removed (wait=true)
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveNodeGroupNodeAccepted'
          description: The removal was accepted (wait=false)
        '401':
          description: Unauthorized
        '403':
          description: Permission check failed
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: >-
            The cluster was not found, or the named node is not in the node
            group
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: >-
            Refused: the cluster is stopped (start it first); the node is not a
            worker, belongs to another node group, is already marked for
            deletion, or its server is stopping; it is the node group's last
            node that has joined the cluster (scale the node group to 0 or
            delete it instead); the removal would take an autoscaling group
            below its min_count; the name matches several nodes, cannot be
            resolved right now, or is a providerID the nodes' `k3s://`
            placeholders cannot be matched with; or the same removal is already
            in flight
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - BearerAuth: []
components:
  schemas:
    RemoveNodeGroupNodeResult:
      properties:
        group_name:
          title: Group Name
          type: string
        node_name:
          description: >-
            The server name of the removed worker, as the node group's node list
            shows it. It is not always the name of its Kubernetes node: that is
            kubernetes_node_name.
          title: Node Name
          type: string
        kubernetes_node_name:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The name of the Kubernetes node the removed worker registered as:
            its lowercased server name on every provider but AWS, where it is
            the EC2 private DNS name the platform records once the instance
            exists. Null while that is not recorded yet.
          title: Kubernetes Node Name
        node_id:
          description: The node id of the removed worker.
          format: uuid
          title: Node Id
          type: string
        previous_count:
          description: The group's node count before the removal.
          title: Previous Count
          type: integer
        new_count:
          description: The group's node count once the worker is gone.
          title: New Count
          type: integer
        operation_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          description: >-
            The operation draining and deleting the worker, followed on
            /api/v1/org/executions/{execution_id}. Null when the request created
            none: the removal is saved and the platform's reconcile dispatches
            it, because the request could not start the operation itself:
            another operation is still changing a node of the cluster, or a
            reconcile pass holds the cluster's dispatch; the cluster is inside a
            force-stop admission window; the work waits for the cluster's agent,
            which is offline; the re-planned deletes are held to their retry
            backoff; or creating the operation failed.
          title: Operation Id
      required:
        - group_name
        - node_name
        - kubernetes_node_name
        - node_id
        - previous_count
        - new_count
        - operation_id
      title: RemoveNodeGroupNodeResult
      type: object
    RemoveNodeGroupNodeAccepted:
      description: >-
        A wait=false removal the platform accepted. When the removal was decided
        within the request it carries the members a wait=true call answers with,
        operation_id included (null when the request created no operation); a
        removal still being decided when the request answered carries `status`
        alone.
      properties:
        status:
          default: accepted
          title: Status
          type: string
        group_name:
          title: Group Name
          type: string
        node_name:
          description: >-
            The server name of the removed worker, as the node group's node list
            shows it. It is not always the name of its Kubernetes node: that is
            kubernetes_node_name.
          title: Node Name
          type: string
        kubernetes_node_name:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The name of the Kubernetes node the removed worker registered as:
            its lowercased server name on every provider but AWS, where it is
            the EC2 private DNS name the platform records once the instance
            exists. Null while that is not recorded yet.
          title: Kubernetes Node Name
        node_id:
          description: The node id of the removed worker.
          format: uuid
          title: Node Id
          type: string
        previous_count:
          description: The group's node count before the removal.
          title: Previous Count
          type: integer
        new_count:
          description: The group's node count once the worker is gone.
          title: New Count
          type: integer
        operation_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          description: >-
            The operation draining and deleting the worker, as
            RemoveNodeGroupNodeResult's operation_id.
          title: Operation Id
      required:
        - status
      title: RemoveNodeGroupNodeAccepted
      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
    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.