openapi: 3.0.3
info:
  title: Baserow API spec Admin Secure file serve API
  version: 2.2.2
  description: 'For more information about our REST API, please visit [this page](https://baserow.io/docs/apis%2Frest-api).


    For more information about our deprecation policy, please visit [this page](https://baserow.io/docs/apis%2Fdeprecations).'
  contact:
    url: https://baserow.io/contact
  license:
    name: MIT
    url: https://github.com/baserow/baserow/blob/develop/LICENSE
tags:
- name: Secure file serve
paths:
  /api/files/{signed_data}:
    get:
      operationId: secure_file_serve_download
      description: 'Downloads a file using the backend and the secure file serve feature. The signed data is extracted from the URL and used to verify if the user has access to the file. If the permissions check passes and the file exists, the file is served to the user.


        This is a **enterprise** feature.'
      parameters:
      - in: path
        name: signed_data
        schema:
          type: string
          pattern: ^.*$
        required: true
      tags:
      - Secure file serve
      responses:
        '200':
          content:
            application/octet-stream:
              schema:
                description: File download
          description: ''
        '403':
          content:
            application/octet-stream:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Machine readable error indicating what went wrong.
                    enum:
                    - ERROR_SECURE_FILE_SERVE_EXCEPTION
                  detail:
                    oneOf:
                    - type: string
                      format: string
                      description: Human readable details about what went wrong.
                    - type: object
                      format: object
                      description: Machine readable object about what went wrong.
          description: ''
components:
  securitySchemes:
    Database token:
      type: http
      scheme: bearer
      bearerFormat: Token your_token
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT your_token
    UserSource JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT your_token