> ## 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. # Restore an application deployment from a restore point > Restores this deployment in place from one of its own restore points. The cluster and stack are resolved from the deployment on the server, and confirm must be that stack's name. A safety restore point of the live stack is taken first and the restore is refused if it cannot be; the workloads are then scaled down, the claims the restore point replaces are removed, the data is restored and the workloads are scaled back up. A refusal answers with the sentence as detail and a stable error_code. force overrides drift and nothing else. Requires the backups rollout flag and backups.operate. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json post /api/v1/org/applications/{application_id}/deployments/{deployment_id}/restore-points/{restore_point_id}/restore openapi: 3.1.0 info: title: FastAPI version: 0.1.0 servers: - url: https://platform.ankra.app security: [] tags: - 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: 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: 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/applications/{application_id}/deployments/{deployment_id}/restore-points/{restore_point_id}/restore: post: tags: - Backups summary: Restore an application deployment from a restore point description: >- Restores this deployment in place from one of its own restore points. The cluster and stack are resolved from the deployment on the server, and confirm must be that stack's name. A safety restore point of the live stack is taken first and the restore is refused if it cannot be; the workloads are then scaled down, the claims the restore point replaces are removed, the data is restored and the workloads are scaled back up. A refusal answers with the sentence as detail and a stable error_code. force overrides drift and nothing else. Requires the backups rollout flag and backups.operate. operationId: restoreApplicationDeploymentToken parameters: - in: path name: application_id required: true schema: type: string - name: deployment_id in: path required: true description: The deployment cluster id. schema: type: string format: uuid - name: restore_point_id in: path required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApplicationRestoreRequest' responses: '202': description: The restore run was opened. content: application/json: schema: $ref: '#/components/schemas/ApplicationRestoreAccepted' '400': description: >- The confirmation does not match the stack name (confirmation_mismatch), or the mode is not in_place (mode_unsupported). content: application/json: schema: $ref: '#/components/schemas/ApplicationRestoreRefusal' '401': description: Not authenticated. '403': description: backups.operate is not held, or the backups rollout is off. '404': description: >- Unknown application, deployment or restore point, or the stack is no longer on the cluster (stack_not_found). content: application/json: schema: $ref: '#/components/schemas/ApplicationRestoreRefusal' '409': description: >- The restore is refused: stack_drift (restore with force to proceed), engine_unsupported, nothing_to_restore, unnamed_claims, foreign_claims, cluster_unavailable, operations_blocked, agent_missing, restore_point_not_complete, or the deployment has not created its stack yet. content: application/json: schema: $ref: '#/components/schemas/ApplicationRestoreRefusal' '422': description: >- A safety restore point of the live stack cannot be taken (safety_copy_unavailable), or a path id is not a UUID. content: application/json: schema: $ref: '#/components/schemas/ApplicationRestoreRefusal' '500': description: Internal error. security: - BearerAuth: [] components: schemas: ApplicationRestoreRequest: type: object description: >- Confirms an in-place restore of one application deployment. The cluster and the stack are never sent: they are resolved from the deployment on the server. required: - confirm properties: confirm: type: string description: >- The deployment's stack name, as the restore plan returns it in stack_name. force: type: boolean default: false description: >- Proceed although the stack's data no longer matches the restore point. It overrides drift and no other refusal. mode: type: string enum: - in_place description: Optional. Any other value is refused rather than read as in_place. ApplicationRestoreAccepted: type: object additionalProperties: true required: - restore_point_id - run_id - mode - sequence - warnings - restore_point properties: restore_point_id: type: string format: uuid run_id: type: string format: uuid description: The restore run to follow. mode: type: string enum: - in_place sequence: type: array items: type: string description: >- What the restore does, in order. It opens with the safety restore point when one is taken, naming its id. warnings: type: array items: type: string restore_point: type: object additionalProperties: true description: The restore point being restored, without its manifest. ApplicationRestoreRefusal: type: object required: - detail properties: detail: type: string description: The refusal, as a sentence. error_code: type: string enum: - mode_unsupported - restore_point_not_complete - not_restorable_in_place - confirmation_mismatch - engine_unsupported - nothing_to_restore - unnamed_claims - cluster_unavailable - operations_blocked - agent_missing - foreign_claims - stack_drift - safety_copy_unavailable - stack_not_found description: >- The stable code of a refusal of the restore itself. Absent on an answer that is not one of the restore's rules, such as an unknown application or a dark organisation. securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.