autobrr Torznab API

openapi: 3.2.0
info:
  title: qui Torznab 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: Torznab
paths:
  /api/torznab/search:
    post:
      tags:
      - Torznab
      summary: Search configured Torznab indexers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TorznabSearchRequest'
      responses:
        '200':
          description: Search results, possibly partial when some indexers were unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TorznabSearchResponse'
        '400':
          description: Invalid search request
        '429':
          $ref: '#/components/responses/TorznabRateLimited'
        '500':
          description: Search failed
      operationId: postApiTorznabSearch
      x-operation-id-source: derived
  /api/torznab/cross-seed/search:
    post:
      tags:
      - Torznab
      summary: Search configured Torznab indexers for cross-seeds
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TorznabSearchRequest'
      responses:
        '200':
          description: Search results, possibly partial when some indexers were unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TorznabSearchResponse'
        '400':
          description: Invalid search request
        '429':
          $ref: '#/components/responses/TorznabRateLimited'
        '500':
          description: Search failed
      operationId: postApiTorznabCrossSeedSearch
      x-operation-id-source: derived
  /api/torznab/indexers/{indexerID}/test:
    post:
      tags:
      - Torznab
      summary: Test a Torznab indexer connection
      parameters:
      - name: indexerID
        in: path
        required: true
        schema:
          type: integer
          minimum: 1
      responses:
        '200':
          description: Indexer connection succeeded
        '400':
          description: Invalid indexer ID
        '404':
          description: Indexer not found
        '429':
          $ref: '#/components/responses/TorznabRateLimited'
        '500':
          description: Indexer connection failed
      operationId: postApiTorznabIndexersByIndexerIDTest
      x-operation-id-source: derived
  /api/torznab/indexers/{indexerID}/caps/sync:
    post:
      tags:
      - Torznab
      summary: Refresh stored Torznab capabilities
      parameters:
      - name: indexerID
        in: path
        required: true
        schema:
          type: integer
          minimum: 1
      responses:
        '200':
          description: Capabilities refreshed
        '400':
          description: Invalid indexer ID or configuration
        '404':
          description: Indexer not found
        '429':
          $ref: '#/components/responses/TorznabRateLimited'
        '500':
          description: Capabilities refresh failed
      operationId: postApiTorznabIndexersByIndexerIDCapsSync
      x-operation-id-source: derived
components:
  schemas:
    TorznabSearchResponse:
      type: object
      required:
      - results
      - total
      properties:
        results:
          type: array
          items:
            type: object
            additionalProperties: true
        total:
          type: integer
        partial:
          type: boolean
        jobId:
          type: integer
          format: uint64
        cache:
          type: object
          additionalProperties: true
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: string
    TorznabSearchRequest:
      type: object
      properties:
        query:
          type: string
        release_name:
          type: string
        categories:
          type: array
          items:
            type: integer
        imdb_id:
          type: string
        tvdb_id:
          type: string
        tmdb_id:
          type: integer
        tvmaze_id:
          type: integer
        year:
          type: integer
        season:
          type: integer
        episode:
          type: integer
        artist:
          type: string
        album:
          type: string
        limit:
          type: integer
        offset:
          type: integer
        indexer_ids:
          type: array
          items:
            type: integer
        cache_mode:
          type: string
          enum:
          - ''
          - bypass
  responses:
    TorznabRateLimited:
      description: An upstream indexer requested a retry after its cooldown
      headers:
        Retry-After:
          description: Seconds until the request may be retried
          schema:
            type: integer
            minimum: 0
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  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.

        '