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

# Withdraw a pending application deployment removal (browser session)

> Take back the removal of one deployment that was removed while its cluster was stopped and is still waiting for the cluster to start. The deployment's resources stop being removed, it is declared in the cluster's Git repository again, and its installation gets back the status and error it had before the removal. On a stopped cluster the deployment comes back when the cluster starts; on a cluster that has started but has not carried the removal out yet, it is applied again now. Once the removal has been carried out there is nothing to take back: deploy the application again. Held to the applications.deploy permission. Browser session authentication with the X-Ankra-CSRF double-submit header; the bearer twin is POST /api/v1/org/applications/{application_id}/deployments/withdraw-removal.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /org/applications/{application_id}/deployments/withdraw-removal
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:
  /org/applications/{application_id}/deployments/withdraw-removal:
    post:
      tags:
        - Applications
      summary: Withdraw a pending application deployment removal (browser session)
      description: >-
        Take back the removal of one deployment that was removed while its
        cluster was stopped and is still waiting for the cluster to start. The
        deployment's resources stop being removed, it is declared in the
        cluster's Git repository again, and its installation gets back the
        status and error it had before the removal. On a stopped cluster the
        deployment comes back when the cluster starts; on a cluster that has
        started but has not carried the removal out yet, it is applied again
        now. Once the removal has been carried out there is nothing to take
        back: deploy the application again. Held to the applications.deploy
        permission. Browser session authentication with the X-Ankra-CSRF
        double-submit header; the bearer twin is POST
        /api/v1/org/applications/{application_id}/deployments/withdraw-removal.
      operationId: withdraw_application_deployment_removal
      parameters:
        - in: path
          name: application_id
          required: true
          schema:
            type: string
            title: Application Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveDeploymentRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WithdrawDeploymentRemovalResponse'
          description: The removal was taken back
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: >-
            You do not have permission to take back the removal of this
            application's deployments.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
          description: >-
            Not found ("Application not found" or "Target cluster not found in
            this organisation.")
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentRemovalNotPendingError'
          description: >-
            `error_code` `removal_not_pending`: the deployment has no removal
            waiting for its cluster to start. It was not removed while its
            cluster was stopped, or the cluster has started and the removal is
            being carried out.
        '422':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/DemoDetailError'
                  - $ref: '#/components/schemas/HTTPValidationError'
          description: >-
            {detail} when the body names both a namespace and a stack, the
            cluster id is malformed, the namespace or stack name is empty, or
            the named stack is not one this application's deploys created there
            or belongs to one of its installations; the validation list when a
            body field is missing
      security:
        - SessionCookie: []
      servers:
        - url: https://api.platform.ankra.app
components:
  schemas:
    RemoveDeploymentRequest:
      description: >-
        Name the deployment to remove: the cluster it runs on and either the
        namespace it runs in (an installation) or the stack a deploy-wizard run
        created for it (a wizard deployment, which has no installation). Not
        both.
      properties:
        cluster_id:
          type: string
          title: Cluster Id
        namespace:
          title: Namespace
          type: string
          description: The installation's namespace.
        stack_name:
          title: Stack Name
          type: string
          description: The wizard stack's name, for a deployment with no installation.
      required:
        - cluster_id
      title: RemoveDeploymentRequest
      type: object
    WithdrawDeploymentRemovalResponse:
      description: >-
        The removal taken back: which deployment, what its installation reads
        again, when it is applied again, and where the change stands in Git.
      properties:
        removal_withdrawn:
          title: Removal Withdrawn
          type: boolean
        cluster_id:
          type: string
          title: Cluster Id
        namespace:
          title: Namespace
          type: string
          description: The installation's namespace; empty for a wizard stack.
        installation_id:
          title: Installation Id
          type: string
          description: Absent for a wizard stack, which has no installation.
        stack_name:
          title: Stack Name
          type: string
          description: The wizard stack kept; absent for an installation.
        status:
          title: Status
          type: string
          description: >-
            The installation's status again: the one it had when the removal was
            asked for. Absent for a wizard stack.
        status_assumed:
          title: Status Assumed
          type: boolean
          description: >-
            No status was recorded with the removal (it was asked for before the
            status was kept), so status is deploying until the deployment is
            checked again.
        applied_now:
          title: Applied Now
          type: boolean
          description: >-
            The cluster was not stopped, so the deployment is being applied
            again now rather than when the cluster starts.
        commit_deferred:
          title: Commit Deferred
          type: boolean
          description: >-
            The change is recorded, and its Git commit waits for the cluster to
            sync. commit_sha and commit_url are then null.
        commit_sha:
          anyOf:
            - type: string
            - type: 'null'
          title: Commit Sha
        commit_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Commit Url
        commit_failure:
          title: Commit Failure
          type: string
          description: >-
            Why the push to the Git repository failed, when it did. The removal
            is taken back all the same, and the next sync of the cluster carries
            the change to Git.
        message:
          title: Message
          type: string
          description: The same in a sentence or a few, for a terminal or a chat reply.
      required:
        - removal_withdrawn
        - cluster_id
        - namespace
        - status_assumed
        - applied_now
        - commit_deferred
        - commit_sha
        - commit_url
        - message
      title: WithdrawDeploymentRemovalResponse
      type: object
    DemoDetailError:
      description: >-
        The FastAPI-style detail envelope the demo routes use for
        400/403/404/409/502 responses.
      properties:
        detail:
          type: string
      required:
        - detail
      type: object
    DeploymentRemovalNotPendingError:
      description: >-
        Why a removal could not be taken back: there is none waiting for the
        cluster to start.
      properties:
        detail:
          type: string
        error_code:
          enum:
            - removal_not_pending
          type: string
      required:
        - detail
        - error_code
      title: DeploymentRemovalNotPendingError
      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
    SessionCookie:
      description: Browser session. Mutations also require X-Ankra-CSRF.
      in: cookie
      name: ankra_session
      type: apiKey

````

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