Slide Restores (Push) API

openapi: 3.0.0
info:
  contact:
    email: hey@slide.tech
    name: Slide Team
    url: https://docs.slide.tech
  description: "## Introduction\nThe Slide API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n\n## Authentication\nWe use API tokens to authenticate requests. You can view and manage your API tokens in the [Slide Console](https://docs.slide.tech).\nWhen making HTTP requests, you'll need to include the API token in the `Authorization` header, using Bearer auth (e.g. `Authorization: Bearer YOUR_SECRET_TOKEN`).\n\nExample:\n```shell\n$ curl -H 'Authorization: Bearer YOUR_SECRET_TOKEN' 'https://api.slide.tech/v1/device'\n```\n\n## Pagination\nAll list endpoints support pagination. You can use the `limit` and `offset` query parameters to control the number of items returned and the starting index.\nList responses will include a `pagination` key that includes the `next_offset` to use for pagination.\nIf `next_offset` is not present, that indicates there are no more items to fetch.\n\nExample:\n```shell\n$ curl -H 'Authorization: Bearer YOUR_SECRET_TOKEN' \\\n    'https://api.slide.tech/v1/device?offset=0&limit=10'\n{\n    \"pagination\": {\n        \"next_offset\": 10\n    },\n    \"data\": [\n        ...\n    ]\n}\n```\n\n## Rate Limiting\nWe limit the number of requests you can make to the API within a certain time frame.\nEach API token has a pool of `50` requests. We refill this pool at a rate of `10` requests per second.\nIf you exceed the rate limit, you'll receive a response with a `429 Too Many Requests` HTTP code and a `err_rate_limit_exceeded` error code.\nPlease wait before retrying the request. We recommend you implement an exponential backoff strategy to handle rate limits.\n\n## Errors\nSlide uses conventional HTTP response codes to indicate the success or failure of an API request.\nIn general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted), and codes in the 5xx range indicate an error with Slide's servers.\n\nWe also include [error codes and details](#model/error) in the response, which may provide more context about the error.\n\nExample:\n```shell\n$ curl 'https://api.slide.tech/v1/device'\n{\n    \"codes\": [\n        \"err_missing_authentication\"\n    ],\n    \"details\": [\n        ...\n    ],\n    \"message\": \"unauthorized\"\n}\n```\n\nSome common error codes are:\n\n| Code                         | Description                                                                                                                                             |\n|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `err_endpoint_not_found`     | Requested endpoint does not exist.                                                                                                                      |\n| `err_entity_not_found`       | Requested entity does not exist.                                                                                                                        |\n| `err_validation_error`       | Bad request due to validation error. The error `details` will contain any fields that were not valid.                                                   |\n| `err_missing_authentication` | Unauthorized due to missing API token. See [authentication](#description/authentication) for more details.                                              |\n| `err_unauthorized`           | Unauthorized due to invalid API token. You've provided an invalid API token or the API token does not have permission to access the requested resource. |\n| `err_internal_server_error`  | Something went wrong. If you retry the request and it does not succeed, you may contact us at `hey@slide.tech`.                                         |\n| `err_rate_limit_exceeded`    | Rate limit exceeded. Please wait before retrying the request. See [rate limiting](#description/rate-limiting) for more details.                         |\n\n<details>\n  <summary>Show more error codes.</summary>\n\n| Code                                | Description                                                                                                           |\n|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------|\n| `err_agent_not_connected_to_device` | Agent is not connected to the device. Ensure the agent is powered on and has network connectivity.                    |\n| `err_device_not_connected_to_cloud` | Device is not connected to the cloud. Ensure the device is powered on and has network connectivity.                   |\n| `err_backup_already_running`        | A backup is already running for this agent. Please wait for the current backup to complete before starting a new one. |\n| `err_client_not_found`              | Client not found. Ensure the client ID is valid and the client exists.                                                |\n\n</details>\n\n## Eventual Consistency\n\nSlide operates an eventual consistency model, where data may not be immediately available after an operation.\nThis is due to the distributed nature of our system and the need for replication and synchronization across multiple\nsystems. Users should expect that operations may take a short period of time to propagate and become visible to all\ncomponents of the system.\n\n## Deprecations and Breaking Changes\n\n### Active Deprecations\n\n`Device.ip_addresses` and `Agent.ip_addresses` will be removed. They have been replaced by `Device.addresses` and `Agent.addresses` respectively.\n"
  title: Slide Accounts Restores (Push) API
  version: 1.34.0
servers:
- url: https://api.slide.tech
security:
- BearerAuth: []
tags:
- description: Everything about [push file restores](#model/filerestorepush)
  name: Restores (Push)
paths:
  /v1/restore/file/{file_restore_id}/push:
    get:
      operationId: FileRestorePushes
      parameters:
      - $ref: '#/components/parameters/QueryOffset'
      - $ref: '#/components/parameters/QueryLimit'
      - $ref: '#/components/parameters/PathFileRestoreID'
      - description: Sort by a specific field
        in: query
        name: sort_by
        schema:
          default: start_time
          enum:
          - start_time
          type: string
      - $ref: '#/components/parameters/QuerySortAsc'
      - description: Filter file restore pushes to before a specific start timestamp (RFC3339 format)
        in: query
        name: start_time_before
        schema:
          format: date-time
          type: string
      - description: Filter file restore pushes to after a specific start timestamp (RFC3339 format)
        in: query
        name: start_time_after
        schema:
          format: date-time
          type: string
      - description: Filter file restore pushes to before a specific end timestamp (RFC3339 format)
        in: query
        name: end_time_before
        schema:
          format: date-time
          type: string
      - description: Filter file restore pushes to after a specific end timestamp (RFC3339 format)
        in: query
        name: end_time_after
        schema:
          format: date-time
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                description: Paginated response
                properties:
                  data:
                    description: List of file restore pushes
                    items:
                      $ref: '#/components/schemas/FileRestorePush'
                    title: FileRestorePushes
                    type: array
                  pagination:
                    $ref: '#/components/schemas/Pagination'
                required:
                - pagination
                - data
                title: Paginated response
                type: object
          description: OK
        '401':
          $ref: '#/components/responses/401'
        '500':
          $ref: '#/components/responses/500'
      summary: List push operations
      tags:
      - Restores (Push)
    post:
      operationId: FileRestorePushCreate
      parameters:
      - $ref: '#/components/parameters/PathFileRestoreID'
      requestBody:
        content:
          application/json:
            examples:
              linux:
                summary: Push a file to a Linux agent
                value:
                  destination_folder: /SlideRestore
                  source_file_path: root/home/admin/important.txt
              windows:
                summary: Push a file to a Windows agent
                value:
                  destination_folder: C:\SlideRestore
                  source_file_path: C/Users/Administrator/Documents/ImportantFile.docx
            schema:
              properties:
                destination_folder:
                  $ref: '#/components/schemas/PushDestinationFolder'
                source_file_path:
                  $ref: '#/components/schemas/PushSourceFilePath'
              required:
              - source_file_path
              - destination_folder
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileRestorePush'
          description: Created
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Push a file to the protected system
      tags:
      - Restores (Push)
  /v1/restore/file/{file_restore_id}/push/{file_restore_push_id}:
    get:
      operationId: FileRestorePushStatus
      parameters:
      - $ref: '#/components/parameters/PathFileRestoreID'
      - $ref: '#/components/parameters/PathFileRestorePushID'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileRestorePush'
          description: OK
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Get Status of push operation
      tags:
      - Restores (Push)
    patch:
      operationId: FileRestorePushUpdate
      parameters:
      - $ref: '#/components/parameters/PathFileRestoreID'
      - $ref: '#/components/parameters/PathFileRestorePushID'
      requestBody:
        content:
          application/json:
            example: "{\n  \"state\": \"canceled\"\n}"
            schema:
              properties:
                state:
                  description: Current state of the push operation. Can be updated from in_progress to canceled.
                  enum:
                  - canceled
                  example: canceled
                  type: string
              required:
              - state
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileRestorePush'
          description: Accepted
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Update a push operation
      tags:
      - Restores (Push)
components:
  responses:
    '500':
      content:
        application/json:
          examples:
            err_internal_server_error:
              summary: Internal server error
              value:
                codes:
                - err_internal_server_error
                details:
                - Something went wrong processing your request. See https://docs.slide.tech/api/#description/errors for more information.
                message: internal server error
          schema:
            $ref: '#/components/schemas/Error'
      description: Internal server error
    '404':
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Not found
    '401':
      content:
        application/json:
          examples:
            err_missing_authentication:
              summary: Missing API token
              value:
                codes:
                - err_missing_authentication
                details:
                - 'You did not provide an API token. You need to provide your API token in the Authorization header, using Bearer auth (e.g. ''Authorization: Bearer YOUR_SECRET_TOKEN'').'
                message: unauthorized
            err_unauthorized:
              summary: Invalid API token
              value:
                codes:
                - err_unauthorized
                details:
                - Invalid API token provided or you do not have permission to access this resource.
                message: unauthorized
          schema:
            $ref: '#/components/schemas/Error'
      description: Unauthorized
    '400':
      content:
        application/json:
          examples:
            err_validation_error:
              summary: Validation error
              value:
                codes:
                - err_validation_error
                details:
                - 'parameter "device_id" in path has an error: string doesn''t match the regular expression "^d_[a-z0-9]{12}$"'
                message: bad request
          schema:
            $ref: '#/components/schemas/Error'
      description: Bad request
  parameters:
    PathFileRestorePushID:
      example: frp_0123456789ab
      in: path
      name: file_restore_push_id
      required: true
      schema:
        $ref: '#/components/schemas/FileRestorePushID'
    QuerySortAsc:
      description: Sort in ascending order
      in: query
      name: sort_asc
      schema:
        default: false
        type: boolean
    PathFileRestoreID:
      example: fr_0123456789ab
      in: path
      name: file_restore_id
      required: true
      schema:
        $ref: '#/components/schemas/FileRestoreID'
    QueryOffset:
      description: Starting index for pagination
      in: query
      name: offset
      schema:
        default: 0
        format: uint32
        minimum: 0
        type: integer
    QueryLimit:
      description: Number of items to return for pagination
      in: query
      name: limit
      schema:
        default: 10
        format: uint32
        maximum: 50
        minimum: 1
        type: integer
  schemas:
    FileRestoreID:
      description: ID of a file restore
      example: fr_0123456789ab
      externalDocs:
        description: See our console documentation for more information on file restores
        url: https://docs.slide.tech/restores/#file-restore
      pattern: ^fr_[a-z0-9]{12}$
      type: string
    Error:
      description: Error response object that represents an error that occurred during a request.
      properties:
        codes:
          description: List of error codes that occurred during a request.
          items:
            description: A unique error code that identifies the error.
            title: Code
            type: string
          title: Codes
          type: array
        details:
          description: List of error details that occurred during a request. This may contain action(s) that need to be taken before retrying the request.
          items:
            description: Short detail message describing the error.
            title: Detail
            type: string
          title: Details
          type: array
        message:
          description: Short message describing the error.
          title: Message
          type: string
      required:
      - codes
      - message
      - details
    PushSourceFilePath:
      description: 'Path of the file as it appears inside the mounted file restore — not the file''s path on the protected system.

        The leading path component is the source volume''s identifier (the drive letter for Windows, e.g. `C`, or `root` for the

        root mount on Linux), followed by forward-slash-separated path components (e.g. `C/Users/Administrator/Documents/ImportantFile.docx`

        for a Windows C: drive, or `root/home/admin/important.txt` for a Linux root mount).

        '
      example: C/Users/Administrator/Documents/ImportantFile.docx
      type: string
    PushState:
      description: Current state of the push operation
      enum:
      - created
      - in_progress
      - completed
      - failed
      - canceled
      example: completed
      type: string
    PushDestinationFolder:
      description: 'The folder on the protected system where the pushed file is restored.

        For security reasons, restores are only permitted to a `SlideRestore` folder rooted at a known mount point on the agent:

        for Windows agents, the root of a drive (e.g. `C:\SlideRestore`); for Linux agents, an absolute path under a mounted

        volume that ends in `/SlideRestore` (e.g. `/SlideRestore` for the root mount, or `/data/SlideRestore` for a `/data` mount).

        '
      example: C:\SlideRestore
      pattern: ^([A-Z]:\\SlideRestore|(/[^/]+)*/SlideRestore)$
      type: string
    FileRestorePush:
      description: File restore push object that represents an attempt to restore a file to a protected system.
      properties:
        destination_folder:
          $ref: '#/components/schemas/PushDestinationFolder'
        end_time:
          description: Timestamp of when the push operation ended
          example: '2024-08-23T01:25:08Z'
          format: date-time
          type: string
        file_restore_id:
          $ref: '#/components/schemas/FileRestoreID'
        file_restore_push_id:
          $ref: '#/components/schemas/FileRestorePushID'
        size:
          description: Size of the file in bytes
          example: 21536
          type: integer
        source_file_path:
          $ref: '#/components/schemas/PushSourceFilePath'
        start_time:
          description: Timestamp of when the push operation started
          example: '2024-08-23T01:25:08Z'
          format: date-time
          type: string
        state:
          $ref: '#/components/schemas/PushState'
      required:
      - file_restore_push_id
      - file_restore_id
      - start_time
      - state
      - source_file_path
      - destination_folder
      type: object
    FileRestorePushID:
      description: ID of a file restore push
      example: frp_0123456789ab
      externalDocs:
        description: See our console documentation for more information on pushing files to protected systems
        url: https://docs.slide.tech/restores/#push-to-protected-system
      pattern: ^frp_[a-z0-9]{12}$
      type: string
    Pagination:
      properties:
        next_offset:
          description: Next offset to use for pagination. If this field is not present, that indicates there are no more items to fetch.
          example: 10
          format: uint32
          type: integer
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: string
      scheme: bearer
      type: http