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

> Reads one backup, to follow it until it has `completed` or `failed`.



## OpenAPI

````yaml get /servers/{server}/backups/{backup}
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/{backup}:
    get:
      summary: Get a backup
      description: Reads one backup, to follow it until it has `completed` or `failed`.
      operationId: getServerBackup
      parameters:
        - $ref: '#/components/parameters/server'
        - $ref: '#/components/parameters/backup'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: GetServerBackupOk
                properties:
                  status:
                    type: boolean
                    examples:
                      - true
                  backup:
                    $ref: '#/components/schemas/backup'
          description: The backup and how far it has got.
        '403':
          description: User does not own the server.
        '404':
          content:
            application/json:
              schema:
                type: object
                title: GetServerBackupNotFound
                properties:
                  status:
                    type: boolean
                    examples:
                      - false
                  error:
                    type: string
                    examples:
                      - Backup not found
          description: Server not found, or no backup with this ID on the server.
      security:
        - Authorization: []
components:
  parameters:
    server:
      in: path
      name: server
      schema:
        type: string
      required: true
    backup:
      in: path
      name: backup
      schema:
        type: integer
      required: true
      description: Backup ID
  schemas:
    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.
  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.