> ## 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 Backup Schedule

> Create a recurring backup schedule for a VM.

- **Daily** — set `type` to `daily`. Runs every day at `time`.
- **Weekly** — set `type` to `weekly` and pass `day_of_week` (Monday–Sunday). Runs on that day at `time`.

`keep_count` controls retention — older backups beyond this count are pruned automatically.


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


## OpenAPI

````yaml POST /api/v1/backup-schedules
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/backup-schedules:
    post:
      tags:
        - Backup Schedules
      summary: Create backup schedule
      description: >
        Create a recurring backup schedule for a VM.


        - **Daily** — set `type` to `daily`. Runs every day at `time`.

        - **Weekly** — set `type` to `weekly` and pass `day_of_week`
        (Monday–Sunday). Runs on that day at `time`.


        `keep_count` controls retention — older backups beyond this count are
        pruned automatically.
      operationId: createBackupSchedule
      parameters:
        - $ref: '#/components/parameters/ProjectIDHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBackupScheduleRequest'
      responses:
        '201':
          description: Backup schedule created
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/BackupSchedule'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
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:
    CreateBackupScheduleRequest:
      type: object
      required:
        - vm_id
        - type
        - time
        - keep_count
      properties:
        vm_id:
          type: string
          format: uuid
          description: Target VM UUID
        type:
          type: string
          enum:
            - daily
            - weekly
          description: Schedule frequency
        time:
          type: string
          description: Time of day to run the backup (e.g. `8am`, `13:00`)
          example: 8am
        day_of_week:
          type: string
          enum:
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
            - Sunday
          description: Day of week. Required when `type` is `weekly`.
        keep_count:
          type: integer
          minimum: 1
          description: Number of backups to retain before auto-pruning
    BackupSchedule:
      type: object
      required:
        - id
        - name
        - type
        - keep_count
      properties:
        id:
          type: integer
          description: >-
            Backup schedule ID. Use this value in `/backup-schedules/{id}` for
            get, update, and delete.
        account_id:
          type: string
          format: uuid
        project_id:
          type: string
          format: uuid
        created_by:
          type: string
        region:
          type: string
          enum:
            - us-east
        product_vm:
          type: string
          format: uuid
          description: Source VM UUID
        name:
          type: string
          description: Schedule display name
        type:
          type: string
          enum:
            - daily
            - weekly
          description: Schedule frequency
        runtime:
          type: string
          description: Human-readable schedule (e.g. `Daily at 8am`, `Saturday 8am`)
        keep_count:
          type: integer
          description: Number of backups retained before auto-pruning
        price_per_hour:
          type: string
          description: Hourly cost in USD
        size:
          type: string
          description: Total size of backups currently retained for this schedule
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
  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'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication. Each key is bound to a specific account.

````