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

# List available VPS backup plan configurations

> Lists VPS backup plans, cheapest first, together with a per-frequency grouping and summary statistics for the returned page. Pass `frequency`, `isActive`, `minPrice` and/or `maxPrice` to narrow the result, plus the standard filtering query parameters (`_page`, `_limit`, `_search`, `_sort_by`).

**No API key needed** — this endpoint is public.



## OpenAPI

````yaml /openapi.json get /vps-backup-plans/
openapi: 3.0.0
info:
  title: Storiza API
  version: '1.0'
  description: Manage Storiza servers, apps and subscriptions programmatically.
servers:
  - url: https://api.storiza.store
security:
  - bearerAuth: []
tags:
  - name: Servers
    description: Create, order, renew and upgrade VPS servers, and read their details.
  - name: Server power & commands
    description: >-
      Start, stop, reboot and force-stop a server, check its status and run
      commands on it.
  - name: Server settings
    description: >-
      Rename a server, reinstall its operating system and follow its
      installation.
  - name: Server firewall
    description: Turn a server's firewall on or off and manage its rules.
  - name: Server metrics
    description: CPU, memory, disk and network usage, now and over time.
  - name: Server backups
    description: Order the backup add-on, and take, list and delete backups.
  - name: Server snapshots
    description: Take, list and delete snapshots of a server.
  - name: Server sharing
    description: A share link that lets someone else open the server.
  - name: Server catalog
    description: >-
      Plans, operating systems, categories, datacenters and backup plans. Public
      — no key needed.
  - name: Apps
    description: >-
      Deploy, order, renew and configure apps — game servers, databases and
      bots.
  - name: App lifecycle & console
    description: >-
      Start, stop, restart and kill an app, read its output and metrics, and
      send it commands.
  - name: App files
    description: >-
      Read, write, move and delete the files in an app's volume, and its SFTP
      access.
  - name: App backups
    description: Back up an app, download a backup, and restore from one.
  - name: App domains
    description: Your own domains for an app, and their DNS verification.
  - name: App groups
    description: Private networks that let your apps reach each other by hostname.
  - name: App catalog
    description: Templates, plans and locations for apps.
  - name: Subscriptions
    description: What you pay for, how often it renews, and stopping or resuming it.
  - name: Payments
    description: >-
      Follow a payment after an order, and the methods and currencies you can
      pay with.
  - name: Account
    description: Your profile, and a summary of everything you own.
  - name: SSH keys
    description: Public keys you can install on new Linux servers.
paths:
  /vps-backup-plans/:
    get:
      tags:
        - Server catalog
      summary: List available VPS backup plan configurations
      description: >-
        Lists VPS backup plans, cheapest first, together with a per-frequency
        grouping and summary statistics for the returned page. Pass `frequency`,
        `isActive`, `minPrice` and/or `maxPrice` to narrow the result, plus the
        standard filtering query parameters (`_page`, `_limit`, `_search`,
        `_sort_by`).


        **No API key needed** — this endpoint is public.
      parameters:
        - schema:
            type: string
          required: false
          name: _sort_by
          in: query
        - schema:
            type: number
            minimum: 1
            default: 1
          required: false
          name: _page
          in: query
        - schema:
            type: number
            minimum: 1
            maximum: 250
            default: 10
          required: false
          name: _limit
          in: query
        - schema:
            type: string
          required: false
          name: _search
          in: query
        - schema:
            type: string
          required: false
          name: id
          in: query
        - schema:
            type: string
          required: false
          name: name
          in: query
        - schema:
            type: string
          required: false
          name: description
          in: query
        - schema:
            type: string
          required: false
          name: createdAt
          in: query
      responses:
        '200':
          description: VPS backup plans retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  message:
                    type: string
                    enum:
                      - VPS backup plans retrieved successfully
                  data:
                    type: object
                    properties:
                      plans:
                        type: array
                        items:
                          allOf:
                            - $ref: '#/components/schemas/VPSBackupPlan'
                            - properties: {}
                      grouped:
                        type: object
                        additionalProperties:
                          type: array
                          items:
                            allOf:
                              - $ref: '#/components/schemas/VPSBackupPlan'
                              - properties: {}
                      statistics:
                        type: object
                        properties:
                          total:
                            type: number
                          byFrequency:
                            type: object
                            properties:
                              daily:
                                type: number
                              weekly:
                                type: number
                              monthly:
                                type: number
                            required:
                              - daily
                              - weekly
                              - monthly
                          priceRange:
                            type: object
                            properties:
                              min:
                                type: string
                              max:
                                type: string
                            required:
                              - min
                              - max
                        required:
                          - total
                          - byFrequency
                          - priceRange
                    required:
                      - plans
                      - grouped
                      - statistics
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                        minimum: 1
                      limit:
                        type: integer
                        minimum: 1
                      offset:
                        type: integer
                        minimum: 0
                      total:
                        type: integer
                        minimum: 0
                      totalPages:
                        type: integer
                        minimum: 1
                    required:
                      - page
                      - limit
                      - offset
                      - total
                      - totalPages
                required:
                  - success
                  - message
                  - data
                  - pagination
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  type:
                    type: string
                    enum:
                      - API
                  code:
                    type: string
                    enum:
                      - VALIDATION_ERROR
                  error:
                    type: string
                    enum:
                      - Validation error
                  details:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        _errors:
                          type: array
                          items:
                            type: string
                required:
                  - success
                  - type
                  - code
                  - error
                  - details
              example:
                success: false
                type: API
                code: VALIDATION_ERROR
                error: Validation error
                details:
                  _errors:
                    - The whole schema has some validation problems
                  some_field:
                    _errors:
                      - This field has some validation problem
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  type:
                    type: string
                    enum:
                      - API
                  code:
                    type: string
                    enum:
                      - INTERNAL_ERROR
                  error:
                    type: string
                    enum:
                      - Internal server error
                  details:
                    nullable: true
                required:
                  - success
                  - type
                  - code
                  - error
              example:
                success: false
                type: API
                code: INTERNAL_ERROR
                error: Internal server error
      security: []
components:
  schemas:
    VPSBackupPlan:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          maxLength: 100
        description:
          type: string
        frequency:
          type: string
          enum:
            - daily
            - weekly
            - monthly
          default: daily
        frequencyText:
          type: string
        limits:
          type: number
        price:
          type: number
        pricing:
          type: object
          properties:
            price:
              type: number
            formattedPrice:
              type: string
          default:
            price: 0
            formattedPrice: $0.00
          required:
            - price
            - formattedPrice
        duration:
          type: number
          default: 2592000
        features:
          type: array
          items:
            nullable: true
          default: []
        isActive:
          type: boolean
          default: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - name
        - price
      title: VPSBackupPlan
      description: Schema for VPSBackupPlan model
      example:
        id: 00000000-0000-4000-8000-000000000000
        name: 'Backup Plan #1'
        description: Example Backup Plan
        frequency: daily
        frequencyText: Daily
        limits:
          maxStorageGB: 400
          maxBackups: 4
          retentionDays: 7
        price: '4'
        pricing:
          price: 4
          formattedPrice: $4.00
        duration: '2592000'
        features: []
        isActive: true
        createdAt: '2026-10-09T14:57:33.978Z'
        updatedAt: '2026-10-09T14:57:33.978Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from the Storiza dashboard (API & Integrations), sent as
        `Authorization: Bearer stz_…`.

````

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