> ## 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 Snapshot > Create a snapshot of a VM or a volume. - For a **VM snapshot**, set `resource_type` to `vm` and pass the VM UUID as `resource_id`. - For a **volume snapshot**, set `resource_type` to `volume` and pass the integer `volume_id`. Updated May 8, 2026 ## OpenAPI ````yaml POST /api/v1/snapshots 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/snapshots: post: tags: - Snapshots summary: Create snapshot description: > Create a snapshot of a VM or a volume. - For a **VM snapshot**, set `resource_type` to `vm` and pass the VM UUID as `resource_id`. - For a **volume snapshot**, set `resource_type` to `volume` and pass the integer `volume_id`. operationId: createSnapshot parameters: - $ref: '#/components/parameters/ProjectIDHeader' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateSnapshotRequest' responses: '201': description: Snapshot created content: application/json: schema: type: object properties: success: type: boolean data: $ref: '#/components/schemas/Snapshot' '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: CreateSnapshotRequest: type: object required: - resource_type - name properties: resource_type: type: string enum: - vm - volume description: Source type for the snapshot resource_id: type: string format: uuid description: Source VM UUID. Required when `resource_type` is `vm`. volume_id: type: integer description: Source volume ID. Required when `resource_type` is `volume`. name: type: string minLength: 1 maxLength: 128 description: Snapshot display name example: pre-upgrade Snapshot: type: object required: - id - type - name properties: id: type: integer description: Snapshot ID account_id: type: string format: uuid description: Account that owns the snapshot project_id: type: string format: uuid description: Project the snapshot belongs to created_by: type: string description: User ID that created the snapshot type: type: string enum: - vm - volume description: Snapshot source type name: type: string description: Snapshot display name size: type: string description: Current snapshot size target_size: type: string description: Provisioned size of the source disk at snapshot time status: type: string description: > Indicates whether the source VM or volume is currently running on this snapshot: - `active` — this snapshot is **in use**. The source VM/volume has been reverted to it and is running on it now. Deleting an active snapshot is blocked. - `""` (empty) — this snapshot is saved but **not in use**. The source has not been reverted to it (or has been reverted to a different snapshot since). Only one snapshot per source can be `active` at a time. Calling [Restore Snapshot](#tag/Snapshots/operation/restoreSnapshot) flips that snapshot to `active` and clears the previous active one. enum: - '' - active example: active product_vm: type: string format: uuid description: Source VM UUID (when `type` is `vm`) price_per_hour: type: string description: Hourly storage cost in USD created_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. ````