> ## Documentation Index
> Fetch the complete documentation index at: https://docs.celum.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Attach volume

> **Authorisation:** `vm:AttachVolume` on `krn:celum:supervisor:{name}:vm:{vm}`, or on `krn:celum:supervisor:{name}:project:{?project}:vm:{vm}` — the project-qualified form, which is how a policy scopes a tenant to one project. Either resource matching is enough.

**Assistant tool:** `attach_vm_disk`



## OpenAPI

````yaml /openapi.json post /api/supervisors/{name}/vms/{vm}/attach-volume
openapi: 3.0.3
info:
  description: >-
    The HTTP surface of the Celum backend, generated from its own router and

    authorisation map — so this list cannot drift from the server that serves
    it.


    **Every operation states the IAM action and resource it is authorised

    against.** That pairing is the part worth reading: a policy naming the right

    action against the wrong resource matches nothing, and fails silently.


    Request and response bodies come from the Go types the handlers send and

    decode. Where those types do not determine the shape (an interface, a

    map[string]any, an unknown custom encoding), the operation says so in

    `x-celum-schema-gap` instead of carrying a guessed schema.
  title: Celum API
  version: 1.0.0
servers:
  - description: Your Celum deployment
    url: https://{host}
    variables:
      host:
        default: celum.example.com
        description: The host your Celum backend is served from
security:
  - sessionCookie: []
  - bearerToken: []
tags:
  - description: AI assistant & MCP
    name: ai-assistant
  - description: Clusters & CAPI lifecycle
    name: capi
  - description: Certificates & external secrets
    name: certs
  - description: GitOps & apps
    name: gitops
  - description: IAM, audit & auth
    name: iam
  - description: Image library
    name: images
  - description: Infrastructure & supervisors
    name: infrastructure
  - description: Networking
    name: networking
  - description: Observability & platform health
    name: observability
  - description: Platform onboarding & settings
    name: platform-settings
  - description: Projects
    name: projects
  - description: Registries & mirroring
    name: registries
  - description: Security & flows
    name: security
  - description: Storage
    name: storage
  - description: Templates & addons
    name: templates
  - description: Virtualization platform (KubeVirt/CDI)
    name: virt
  - description: Virtual machines
    name: vms
  - description: Workloads & topology
    name: workloads
paths:
  /api/supervisors/{name}/vms/{vm}/attach-volume:
    post:
      tags:
        - vms
      summary: Attach volume
      description: >-
        **Authorisation:** `vm:AttachVolume` on
        `krn:celum:supervisor:{name}:vm:{vm}`, or on
        `krn:celum:supervisor:{name}:project:{?project}:vm:{vm}` — the
        project-qualified form, which is how a policy scopes a tenant to one
        project. Either resource matching is enough.


        **Assistant tool:** `attach_vm_disk`
      operationId: post_supervisors_byName_vms_byVm_attachVolume
      parameters:
        - description: >-
            The supervisor's name, as registered under Administration →
            Supervisors.
          in: path
          name: name
          required: true
          schema:
            type: string
        - description: The virtual machine's name.
          in: path
          name: vm
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api.AttachVolumeRequest.Input'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.AttachVolumeResponse'
          description: Success.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Bad Request.
        '401':
          description: Not authenticated — no valid session cookie or API token.
        '403':
          description: >-
            Authenticated, but no policy allows this action on this resource.
            The body carries the action and resource that were evaluated.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Internal Server Error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorBody'
          description: Bad Gateway.
components:
  schemas:
    api.AttachVolumeRequest.Input:
      properties:
        accessMode:
          type: string
        bus:
          type: string
        claimName:
          type: string
        fsType:
          type: string
        mountPath:
          type: string
        name:
          type: string
        persist:
          type: boolean
        size:
          type: string
        snapshotName:
          type: string
        source:
          type: string
        storageClass:
          type: string
        volumeMode:
          type: string
      type: object
      x-go-type: backend/internal/api.AttachVolumeRequest
    api.AttachVolumeResponse:
      properties:
        mountMessage:
          type: string
        mounted:
          type: boolean
        pvc:
          type: string
        status:
          type: string
        volume:
          type: string
      required:
        - mounted
        - pvc
        - status
        - volume
      type: object
      x-go-type: backend/internal/api.AttachVolumeResponse
    api.ErrorBody:
      properties:
        error:
          type: string
      required:
        - error
      type: object
  securitySchemes:
    sessionCookie:
      description: >-
        The session cookie issued by the OIDC sign-in flow. This is what a
        browser uses.
      in: cookie
      name: k8s-gate-session
      type: apiKey
    bearerToken:
      description: >-
        An API token, minted from your own identity page. A token carries the
        IAM groups you held **when it was minted**, and cannot bypass deletion
        approval — except for guest clusters inside a project that same token
        created.
      scheme: bearer
      type: http

````

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