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

# Create Volume

> Create a new block storage volume. Volumes are created asynchronously — the response returns immediately with `pending` status.

Optionally attach the volume to an existing VM at create time by passing `vm_id`. Volume and VM must be in the same region.

## Filesystem

For Linux VMs, set `filesystem_type` to choose how the volume is formatted:

- `ext4` (default), `xfs`, `btrfs` — Linux filesystems
- Omit for Windows VMs — they always use NTFS

Filesystem is only applied if the volume is attached to a VM that mounts it via cloud-init or the contextualization script.


<sub>Updated May 8, 2026</sub>


## OpenAPI

````yaml POST /api/v1/volumes
openapi: 3.0.3
info:
  title: Raff API
  description: >
    REST API for managing cloud infrastructure on Raff.


    ## Authentication

    Most endpoints require authentication via API key. Catalog endpoints under
    `/api/v1/public/` are open and require no authentication.


    ### API Key Authentication

    Include your API key in the `X-API-Key` header:
      ```
      curl -H "X-API-Key: YOUR_API_KEY" https://api.rafftechnologies.com/api/v1/vms
      ```

    ## Catalog

    Use the public catalog endpoints to discover available regions, OS
    templates, and pricing plans before creating resources:

    - `GET /api/v1/public/regions` — list available regions

    - `GET /api/v1/public/templates` — list OS templates (use the `id` as
    `template_id` when creating a VM)

    - `GET /api/v1/public/pricing/vm` — list VM pricing plans (use the `id` as
    `pricing_id` when creating a VM)

    - `GET /api/v1/public/pricing/volume` — volume storage pricing

    - `GET /api/v1/public/pricing/snapshot` — snapshot storage pricing

    - `GET /api/v1/public/pricing/backup` — backup storage pricing

    - `GET /api/v1/public/pricing/ip` — IP address pricing
  version: 1.0.0
  contact:
    name: Raff Technologies
    url: https://rafftechnologies.com
servers:
  - url: https://api.rafftechnologies.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Catalog
    description: >-
      Discover available regions, OS templates, and pricing plans. No
      authentication required.
  - name: Health
    description: Health check endpoints
  - name: Projects
    description: Organize resources into projects for billing and access control
  - name: Virtual Machines
    description: Create, manage, and control virtual machines
  - name: Networking
    description: >-
      Attach and detach VPCs, floating IPs, and security groups to VM network
      interfaces
  - name: Snapshots
    description: Point-in-time copies of VMs and volumes for quick rollback or cloning
  - name: Backups
    description: Scheduled and on-demand VM backups with restore capability
  - name: Backup Schedules
    description: Recurring daily or weekly backup schedules attached to a VM
  - name: SSH Keys
    description: Manage account-level SSH keys for VM provisioning
  - name: Members
    description: Account-level members — invite, list, update role, remove
  - name: Project Members
    description: Members of a specific project — same model as Members but project-scoped
  - name: Roles
    description: Custom roles bundling account or project permissions
  - name: Permissions
    description: List the catalog of permission strings used by roles
  - name: API Keys
    description: Create and manage API keys for programmatic access
  - name: Invitations
    description: Create and cancel email-based invitations to join the account or a project
paths:
  /api/v1/volumes:
    post:
      tags:
        - Volumes
      summary: Create volume
      description: >
        Create a new block storage volume. Volumes are created asynchronously —
        the response returns immediately with `pending` status.


        Optionally attach the volume to an existing VM at create time by passing
        `vm_id`. Volume and VM must be in the same region.


        ## Filesystem


        For Linux VMs, set `filesystem_type` to choose how the volume is
        formatted:


        - `ext4` (default), `xfs`, `btrfs` — Linux filesystems

        - Omit for Windows VMs — they always use NTFS


        Filesystem is only applied if the volume is attached to a VM that mounts
        it via cloud-init or the contextualization script.
      operationId: createVolume
      parameters:
        - $ref: '#/components/parameters/ProjectIDHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVolumeRequest'
      responses:
        '202':
          description: Volume creation accepted
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/Volume'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/InsufficientBalance'
        '403':
          $ref: '#/components/responses/BillingValidationFailed'
components:
  parameters:
    ProjectIDHeader:
      name: X-Project-ID
      in: header
      required: true
      description: >-
        Project ID. Required for all mutating operations (create, delete, power
        actions, resize).
      schema:
        type: string
        format: uuid
  schemas:
    CreateVolumeRequest:
      type: object
      required:
        - name
        - size
        - volume_type
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 64
          description: Volume display name
          example: data-vol-1
        size:
          type: integer
          minimum: 1
          description: Volume size in GB
          example: 100
        volume_type:
          type: string
          description: Storage class
          enum:
            - nvme
          example: nvme
        filesystem_type:
          type: string
          enum:
            - ext4
            - xfs
            - btrfs
          description: >-
            Filesystem to format the volume with on first attach. Linux only —
            Windows VMs use NTFS automatically. Defaults to `ext4`.
        vm_id:
          type: string
          format: uuid
          description: >-
            Optional. Attach the volume to this VM at create time. VM must be in
            the same region.
        region:
          type: string
          enum:
            - us-east
          description: Region. Defaults to the project's default region.
    Volume:
      type: object
      required:
        - id
        - name
        - volume_type
        - size
        - status
      properties:
        id:
          type: integer
          description: >-
            Volume ID. Use this in `/volumes/{id}` for get, delete, attach,
            detach, resize.
        account_id:
          type: string
          format: uuid
          description: Account that owns the volume
        project_id:
          type: string
          format: uuid
          description: Project the volume belongs to
        product_vm:
          type: string
          format: uuid
          description: >-
            UUID of the VM the volume is currently attached to. Empty when
            detached.
        name:
          type: string
          description: Volume display name
          example: data-vol-1
        volume_type:
          type: string
          description: Storage class
          enum:
            - nvme
          example: nvme
        size:
          type: integer
          description: Volume size in GB
          example: 100
        status:
          type: string
          enum:
            - creating
            - available
            - attached
            - deleting
            - failed
          description: |
            Volume lifecycle status:
            - `creating` — being provisioned on the hypervisor
            - `available` — ready, not attached to any VM
            - `attached` — attached to a VM (see `product_vm`)
            - `deleting` — being torn down
            - `failed` — creation or attach failed
        price_per_hour:
          type: string
          description: Hourly billing rate in USD
        region:
          type: string
          enum:
            - us-east
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
    BillingError:
      type: object
      description: >-
        Billing validation error response. Returned when the account is not in
        good standing for paid operations.
      required:
        - error
        - reason
      properties:
        error:
          type: string
          example: Billing validation failed
        message:
          type: string
          example: Payment failed. Please update your payment method.
        reason:
          type: string
          description: >
            Machine-readable reason code:

            - `banned` — account has been suspended

            - `failed` — last payment failed; balance top-up needed

            - `no_billing_customer` — billing has not been set up for this
            account
          enum:
            - banned
            - failed
            - no_billing_customer
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InsufficientBalance:
      description: >
        Account balance is insufficient for this operation. Top up the balance
        and retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Payment Required
            message: Insufficient balance for subscription
    BillingValidationFailed:
      description: |
        Billing validation failed. The account is not in good standing.
        Check the `reason` field:
        - `banned` — account suspended
        - `failed` — last payment failed; top up the account balance
        - `no_billing_customer` — billing not set up
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BillingError'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication. Each key is bound to a specific account.

````