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

# The persistent volumes deleting a OVH cluster removes

> What deleting the cluster does to its persistent volumes: the cloud volumes its CSI driver provisioned that `DELETE /api/v1/clusters/ovh/{cluster_id}` deletes with the cluster, or keeps when the cluster's retention_policy retains them. Read it before the delete to name the volumes and ask for `accept_volume_data_loss`. A cluster whose inventory was never synced, or could not be read, is unknown, never none.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/clusters/ovh/{cluster_id}/deprovision-volumes
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: 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 and the approval of the authority they declare.
  - 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: 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: AWS Credentials
    description: >-
      AWS credentials: access keys or CloudFormation-onboarded STS roles for
      cost, EKS and self-managed provisioning.
  - 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: 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/clusters/ovh/{cluster_id}/deprovision-volumes:
    get:
      tags:
        - OVH Clusters
      summary: The persistent volumes deleting a OVH cluster removes
      description: >-
        What deleting the cluster does to its persistent volumes: the cloud
        volumes its CSI driver provisioned that `DELETE
        /api/v1/clusters/ovh/{cluster_id}` deletes with the cluster, or keeps
        when the cluster's retention_policy retains them. Read it before the
        delete to name the volumes and ask for `accept_volume_data_loss`. A
        cluster whose inventory was never synced, or could not be read, is
        unknown, never none.
      operationId: get_ovh_cluster_deprovision_volumes_api_v1
      parameters:
        - name: cluster_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - description: PAT organisation override.
          in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeprovisionVolumes'
          description: What the delete does to the cluster's volumes.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Missing, expired or revoked API token
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Cluster not found in this organisation
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Request validation error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Internal server error
      security:
        - BearerAuth: []
components:
  schemas:
    DeprovisionVolumes:
      description: >-
        What deleting a self-managed cluster does to its persistent volumes (the
        cloud volumes its CSI driver provisioned).
      properties:
        cluster_id:
          type: string
          format: uuid
        state:
          description: >-
            present (the delete removes at least one volume), none (it removes
            none: the cluster has none, or its retention_policy keeps them), or
            unknown (the inventory was never synced or could not be read).
            Unknown is never taken as none.
          enum:
            - present
            - none
            - unknown
          type: string
        volume_count:
          anyOf:
            - type: integer
            - type: 'null'
          description: How many volumes the delete removes; null when state is unknown.
        volumes:
          description: The volumes the delete removes, sorted by claim.
          items:
            $ref: '#/components/schemas/DeprovisionVolume'
          type: array
        kept_volumes:
          description: >-
            The volumes the cluster's retention_policy keeps; they keep billing
            at the provider.
          items:
            $ref: '#/components/schemas/DeprovisionVolume'
          type: array
        retention_policy:
          anyOf:
            - enum:
                - retain
                - delete
              type: string
            - type: 'null'
          description: >-
            The cluster's effective retention_policy on AWS and Scaleway (retain
            when unset); null on providers without one.
        warning:
          description: >-
            The sentence to show before the delete; empty when it touches no
            volume.
          type: string
        consent_required:
          description: >-
            True when the delete removes volumes or cannot tell whether it does
            (state present or unknown): the delete then needs
            accept_volume_data_loss.
          type: boolean
      required:
        - cluster_id
        - state
        - volume_count
        - volumes
        - kept_volumes
        - retention_policy
        - warning
        - consent_required
      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
    DeprovisionVolume:
      description: >-
        One cloud volume of the cluster. The members other than volume_id are
        null when the inventory does not know them.
      properties:
        volume_id:
          description: >-
            The provider's volume ID (Hetzner volume ID, UpCloud storage UUID,
            Cinder or DigitalOcean volume ID, zone-prefixed Scaleway volume ID,
            EBS volume ID).
          type: string
        persistent_volume:
          anyOf:
            - type: string
            - type: 'null'
        claim:
          anyOf:
            - type: string
            - type: 'null'
          description: The bound claim as namespace/name.
        storage_class:
          anyOf:
            - type: string
            - type: 'null'
        capacity:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - volume_id
        - persistent_volume
        - claim
        - storage_class
        - capacity
      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

````