autobrr Client API Keys API

Client API key management for external applications

Operations 3

GET /api/client-api-keys List client API keys #
POST /api/client-api-keys Create client API key #
DELETE /api/client-api-keys/{id} Delete client API key #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/autobrr:autobrr-client-api-keys-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

autobrr-client-api-keys-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: qui Client API Keys 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: Client API Keys
  description: Client API key management for external applications
paths:
  /api/client-api-keys:
    get:
      tags:
      - Client API Keys
      summary: List client API keys
      description: Get all client API keys for external applications
      responses:
        '200':
          description: List of client API keys
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClientApiKey'
      operationId: getApiClientApiKeys
      x-operation-id-source: derived
    post:
      tags:
      - Client API Keys
      summary: Create client API key
      description: Generate a new client API key for external applications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - clientName
              - instanceId
              properties:
                clientName:
                  type: string
                  description: Name of the client application (e.g., "Sonarr")
                instanceId:
                  type: integer
                  description: ID of the qBittorrent instance to proxy to
      responses:
        '201':
          description: Client API key created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  clientName:
                    type: string
                  instanceId:
                    type: integer
                  key:
                    type: string
                    description: The client API key (only shown once)
                  createdAt:
                    type: string
                    format: date-time
                  message:
                    type: string
      operationId: postApiClientApiKeys
      x-operation-id-source: derived
  /api/client-api-keys/{id}:
    delete:
      tags:
      - Client API Keys
      summary: Delete client API key
      description: Revoke a client API key
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Client API key deleted successfully
        '404':
          description: Client API key not found
      operationId: deleteApiClientApiKeysById
      x-operation-id-source: derived
components:
  schemas:
    ClientApiKey:
      type: object
      properties:
        id:
          type: integer
        clientName:
          type: string
          description: Name of the client application
        instanceId:
          type: integer
          description: ID of the qBittorrent instance
        instanceName:
          type: string
          description: Name of the qBittorrent instance
        createdAt:
          type: string
          format: date-time
        lastUsedAt:
          type: string
          format: date-time
          nullable: 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.

        '