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

# Get Backups

> Shows whether backups are enabled for the server, its slots and schedule, what
the paid slots cost, its backups, the latest restore and the latest downloads.

Every server can keep **one backup free of charge**. Buying the paid slots
raises that to five, for a monthly surcharge on each renewal.




## OpenAPI

````yaml get /servers/{server}/backups
openapi: 3.1.0
info:
  title: APIFiddle Sample Definition
  version: 0.0.0
  description: Example workspace
servers:
  - url: https://rdp.sh/api/v1
    description: Default production endpoint.
security: []
paths:
  /servers/{server}/backups:
    get:
      summary: Get backups
      description: >
        Shows whether backups are enabled for the server, its slots and
        schedule, what

        the paid slots cost, its backups, the latest restore and the latest
        downloads.


        Every server can keep **one backup free of charge**. Buying the paid
        slots

        raises that to five, for a monthly surcharge on each renewal.
      operationId: getServerBackups
      parameters:
        - $ref: '#/components/parameters/server'
      responses:
        '200':
          content:
            application/json:
              schema:
                title: GetServerBackupsOk
                allOf:
                  - type: object
                    properties:
                      status:
                        type: boolean
                        examples:
                          - true
                  - $ref: '#/components/schemas/backupSettings'
                  - type: object
                    properties:
                      paid_slots_price:
                        type: object
                        description: >
                          What the paid slots cost, VAT of your country included
                          in the

                          amounts. The free slot costs nothing.
                        properties:
                          monthly_amount:
                            type: number
                            description: What the paid slots add to each monthly renewal.
                            examples:
                              - 2.38
                          monthly_net:
                            type: number
                            examples:
                              - 2
                          prorated_amount:
                            type: number
                            description: >-
                              What buying them now charges, for the days left
                              until the server expires.
                            examples:
                              - 1.19
                          prorated_net:
                            type: number
                            examples:
                              - 1
                          remaining_days:
                            type: integer
                            examples:
                              - 15
                          currency:
                            type: string
                            examples:
                              - EUR
                      backups:
                        type: array
                        description: The server's backups, newest first.
                        items:
                          $ref: '#/components/schemas/backup'
                      latest_restore:
                        oneOf:
                          - $ref: '#/components/schemas/backupRestore'
                          - type: 'null'
                      downloads:
                        type: array
                        description: The ten latest downloads, newest first.
                        items:
                          $ref: '#/components/schemas/backupDownload'
          description: The server's backups and how they are set up.
        '403':
          content:
            application/json:
              schema:
                type: object
                title: GetServerBackupsUnauthorized
                properties:
                  status:
                    type: boolean
                    examples:
                      - false
                  error:
                    type: string
                    examples:
                      - This action is unauthorized
          description: User does not own the server.
        '404':
          description: Server not found.
      security:
        - Authorization: []
components:
  parameters:
    server:
      in: path
      name: server
      schema:
        type: string
      required: true
  schemas:
    backupSettings:
      type: object
      required:
        - enabled
        - slots
      properties:
        enabled:
          type: boolean
          description: Whether backups are enabled for the server.
          examples:
            - true
        slots:
          type: object
          properties:
            total:
              type: integer
              description: How many backups the server can keep.
              examples:
                - 1
            free:
              type: integer
              description: How many of them are free of charge.
              examples:
                - 1
            paid:
              type: boolean
              description: Whether the paid slots are bought.
              examples:
                - false
            paid_total:
              type: integer
              description: How many backups the server can keep with the paid slots.
              examples:
                - 5
        schedule:
          description: When the server is backed up, or `null` while backups are disabled.
          oneOf:
            - type: object
              properties:
                frequency:
                  type: string
                  enum:
                    - daily
                    - weekly
                hour:
                  type: integer
                  description: The hour the backup starts, in UTC.
                  examples:
                    - 3
                weekday:
                  type:
                    - integer
                    - 'null'
                  description: 0 = Sunday to 6 = Saturday, for a weekly schedule.
                retention:
                  type: integer
                  description: How many backups are kept.
                  examples:
                    - 1
            - type: 'null'
      description: Whether a server's backups are enabled, its slots and its schedule.
    backup:
      type: object
      required:
        - id
        - type
        - status
      properties:
        id:
          type: integer
          examples:
            - 812
        type:
          type: string
          enum:
            - manual
            - scheduled
        status:
          type: string
          enum:
            - pending
            - running
            - completed
            - failed
          examples:
            - completed
        progress:
          type: integer
          minimum: 0
          maximum: 100
          examples:
            - 100
        size_bytes:
          type:
            - integer
            - 'null'
          examples:
            - 4294967296
        error:
          type:
            - string
            - 'null'
          description: Why the backup failed, once it has.
        created_at:
          type: string
          examples:
            - '2026-10-22T03:00:04+00:00'
        started_at:
          type:
            - string
            - 'null'
        finished_at:
          type:
            - string
            - 'null'
      description: A backup of a server.
    backupRestore:
      type: object
      required:
        - id
        - backup_id
        - status
      properties:
        id:
          type: integer
          examples:
            - 57
        backup_id:
          type: integer
          examples:
            - 812
        status:
          type: string
          enum:
            - pending
            - running
            - completed
            - failed
          examples:
            - running
        progress:
          type: integer
          minimum: 0
          maximum: 100
          examples:
            - 40
        error:
          type:
            - string
            - 'null'
          description: Why the restore failed, once it has.
        created_at:
          type: string
        started_at:
          type:
            - string
            - 'null'
        finished_at:
          type:
            - string
            - 'null'
      description: A restore of a backup onto its server.
    backupDownload:
      type: object
      required:
        - id
        - backup_id
        - status
      properties:
        id:
          type: integer
          examples:
            - 31
        backup_id:
          type: integer
          examples:
            - 812
        status:
          type: string
          enum:
            - pending
            - running
            - completed
            - failed
            - expired
          examples:
            - completed
        progress:
          type: integer
          minimum: 0
          maximum: 100
          examples:
            - 100
        url:
          type:
            - string
            - 'null'
          description: The VMDK file, once it is ready and until the link expires.
        size_bytes:
          type:
            - integer
            - 'null'
        expires_at:
          type:
            - string
            - 'null'
          description: When the link stops working.
        error:
          type:
            - string
            - 'null'
          description: Why preparing the download failed, once it has.
        created_at:
          type: string
      description: A backup prepared as a file to download.
  securitySchemes:
    Authorization:
      in: header
      name: Authorization
      type: apiKey
      description: |
        Your API key as it is, without `Bearer`. API access is off for new
        accounts: until it is turned on under Settings > API, every request
        answers `403` with `API access is turned off for this account. Turn it
        on under Settings > API.` If the account lists allowed IPs, a request
        from any other address answers `403` with `This API key is not allowed
        from <address>`.

````

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