autobrr Proxy API

openapi: 3.2.0
info:
  title: qui Proxy API
  description: 'qui API for managing multiple qBittorrent instances.

    If allowedHosts is configured, a missing, invalid, or unlisted received Host

    returns HTTP 400 before authentication or routing. X-Forwarded-Host is ignored.

    Request ports do not affect matching. Only direct loopback GET and HEAD

    requests to /health, /healthz/readiness, and /healthz/liveness bypass the list.


    For automation create and update requests, set `conditions.category.enabled` to `true`

    and `conditions.category.category` to an empty string to remove the torrent category.

    Set `conditions.category.enabled` to `false` to disable the category action.'
  version: 1.0.0
  license:
    name: GPL-2.0-or-later
    url: https://opensource.org/licenses/GPL-2.0
servers:
- url: http://localhost:7476
  description: Local development server
- url: /
  description: Current server
security:
- ApiKeyAuth: []
- SessionAuth: []
tags:
- name: Proxy
  description: qBittorrent-compatible proxy endpoints authenticated by client API key
paths:
  /proxy/{api-key}/api/v2/torrents/mediainfo:
    get:
      tags:
      - Proxy
      summary: Get MediaInfo via proxy API key
      description: Returns MediaInfo summary text and JSON output for an instance-relative content path using a client API key in the proxy path.
      security: []
      parameters:
      - name: api-key
        in: path
        required: true
        description: Client API key created in qui client API keys.
        schema:
          type: string
      - name: contentPath
        in: query
        required: false
        description: 'Canonical instance-relative content path (legacy alias: content_path)'
        schema:
          type: string
      - name: content_path
        in: query
        required: false
        description: Legacy alias of contentPath
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                contentPath:
                  type: string
                  description: Canonical instance-relative content path
                content_path:
                  type: string
                  description: Legacy alias for contentPath
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                contentPath:
                  type: string
                  description: Canonical instance-relative content path
                content_path:
                  type: string
                  description: Legacy alias for contentPath
      responses:
        '200':
          description: MediaInfo summary and JSON
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentPathMediaInfoResponse'
        '400':
          description: Invalid content path
        '401':
          description: Missing or invalid client API key
        '403':
          description: Instance does not have local filesystem access
        '404':
          description: Instance or file not found
        '500':
          description: Internal server error
      operationId: getProxyByApiKeyApiV2TorrentsMediainfo
      x-operation-id-source: derived
components:
  schemas:
    ContentPathMediaInfoResponse:
      type: object
      required:
      - contentPath
      - summaryTxt
      - mediaInfoJson
      properties:
        contentPath:
          type: string
          description: Normalized instance-relative file path that was analyzed
        summaryTxt:
          type: string
          description: Human-readable MediaInfo text summary
        mediaInfoJson:
          type: object
          description: Parsed MediaInfo JSON output
          additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication
    ApiKeyQuery:
      type: apiKey
      in: query
      name: apikey
      description: API key via query parameter for external webhook integrations
    SessionAuth:
      type: apiKey
      in: cookie
      name: qui_user_session
      description: 'Browser session cookie set by the qui web UI. POST, PUT, PATCH, and DELETE

        requests authenticated by this cookie must also send an `X-Requested-With`

        header. Other clients should use an API key.

        '