Prowlarr

Prowlarr Download Client API

The DownloadClient API from Prowlarr — 7 operation(s) for downloadclient.

GitHub OpenAPI

Operations 11

GET /api/v1/downloadclient/{id} Get api downloadclient by id #
PUT /api/v1/downloadclient/{id} Replace api downloadclient by id #
DELETE /api/v1/downloadclient/{id} Delete api downloadclient by id #
GET /api/v1/downloadclient Get api downloadclient #
POST /api/v1/downloadclient Create api downloadclient #
PUT /api/v1/downloadclient/bulk Replace api downloadclient bulk #
DELETE /api/v1/downloadclient/bulk Delete api downloadclient bulk #
GET /api/v1/downloadclient/schema Get api downloadclient schema #
POST /api/v1/downloadclient/test Create api downloadclient test #
POST /api/v1/downloadclient/testall Create api downloadclient testall #
POST /api/v1/downloadclient/action/{name} Create api downloadclient action by name #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/prowlarr/openapi/prowlarr-downloadclient-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/prowlarr/json-schema/prowlarr-host-config-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/prowlarr/json-schema/prowlarr-release-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/prowlarr/json-schema/prowlarr-indexer-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/prowlarr/json-schema/prowlarr-system-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/prowlarr/json-schema/prowlarr-notification-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/prowlarr/json-schema/prowlarr-command-resource-schema.json

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/prowlarr:prowlarr-downloadclient-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.

GitHub Google LinkedIn

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

OpenAPI Specification

prowlarr-downloadclient-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Prowlarr Download Client API
  description: Prowlarr API docs
  license:
    name: GPL-3.0
    url: https://github.com/Prowlarr/Prowlarr/blob/develop/LICENSE
  version: 1.0.0
servers:
- url: '{protocol}://{hostpath}'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    hostpath:
      default: localhost:9696
security:
- X-Api-Key: []
- apikey: []
tags:
- name: DownloadClient
paths:
  /api/v1/downloadclient/{id}:
    get:
      tags:
      - DownloadClient
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadClientResource'
      summary: Get api downloadclient by id
      x-summary-source: derived
      operationId: getApiV1DownloadclientById
      x-operation-id-source: derived
    put:
      tags:
      - DownloadClient
      parameters:
      - name: forceSave
        in: query
        schema:
          type: boolean
          default: false
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DownloadClientResource'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadClientResource'
      summary: Replace api downloadclient by id
      x-summary-source: derived
      operationId: putApiV1DownloadclientById
      x-operation-id-source: derived
    delete:
      tags:
      - DownloadClient
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
      summary: Delete api downloadclient by id
      x-summary-source: derived
      operationId: deleteApiV1DownloadclientById
      x-operation-id-source: derived
  /api/v1/downloadclient:
    get:
      tags:
      - DownloadClient
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DownloadClientResource'
      summary: Get api downloadclient
      x-summary-source: derived
      operationId: getApiV1Downloadclient
      x-operation-id-source: derived
    post:
      tags:
      - DownloadClient
      parameters:
      - name: forceSave
        in: query
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DownloadClientResource'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadClientResource'
      summary: Create api downloadclient
      x-summary-source: derived
      operationId: postApiV1Downloadclient
      x-operation-id-source: derived
  /api/v1/downloadclient/bulk:
    put:
      tags:
      - DownloadClient
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DownloadClientBulkResource'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadClientResource'
      summary: Replace api downloadclient bulk
      x-summary-source: derived
      operationId: putApiV1DownloadclientBulk
      x-operation-id-source: derived
    delete:
      tags:
      - DownloadClient
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DownloadClientBulkResource'
      responses:
        '200':
          description: OK
      summary: Delete api downloadclient bulk
      x-summary-source: derived
      operationId: deleteApiV1DownloadclientBulk
      x-operation-id-source: derived
  /api/v1/downloadclient/schema:
    get:
      tags:
      - DownloadClient
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DownloadClientResource'
      summary: Get api downloadclient schema
      x-summary-source: derived
      operationId: getApiV1DownloadclientSchema
      x-operation-id-source: derived
  /api/v1/downloadclient/test:
    post:
      tags:
      - DownloadClient
      parameters:
      - name: forceTest
        in: query
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DownloadClientResource'
      responses:
        '200':
          description: OK
      summary: Create api downloadclient test
      x-summary-source: derived
      operationId: postApiV1DownloadclientTest
      x-operation-id-source: derived
  /api/v1/downloadclient/testall:
    post:
      tags:
      - DownloadClient
      responses:
        '200':
          description: OK
      summary: Create api downloadclient testall
      x-summary-source: derived
      operationId: postApiV1DownloadclientTestall
      x-operation-id-source: derived
  /api/v1/downloadclient/action/{name}:
    post:
      tags:
      - DownloadClient
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DownloadClientResource'
      responses:
        '200':
          description: OK
      summary: Create api downloadclient action by name
      x-summary-source: derived
      operationId: postApiV1DownloadclientActionByName
      x-operation-id-source: derived
components:
  schemas:
    DownloadClientBulkResource:
      type: object
      properties:
        ids:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        tags:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        applyTags:
          $ref: '#/components/schemas/ApplyTags'
        enable:
          type:
          - boolean
          - 'null'
        priority:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    DownloadProtocol:
      enum:
      - unknown
      - usenet
      - torrent
      type: string
    PrivacyLevel:
      enum:
      - normal
      - password
      - apiKey
      - userName
      type: string
    ApplyTags:
      enum:
      - add
      - remove
      - replace
      type: string
    DownloadClientResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        fields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Field'
        implementationName:
          type:
          - string
          - 'null'
        implementation:
          type:
          - string
          - 'null'
        configContract:
          type:
          - string
          - 'null'
        infoLink:
          type:
          - string
          - 'null'
        message:
          $ref: '#/components/schemas/ProviderMessage'
        tags:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        presets:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DownloadClientResource'
        enable:
          type: boolean
        protocol:
          $ref: '#/components/schemas/DownloadProtocol'
        priority:
          type: integer
          format: int32
        categories:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DownloadClientCategory'
        supportsCategories:
          type: boolean
      additionalProperties: false
    ProviderMessageType:
      enum:
      - info
      - warning
      - error
      type: string
    DownloadClientCategory:
      type: object
      properties:
        clientCategory:
          type:
          - string
          - 'null'
        categories:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
      additionalProperties: false
    ProviderMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/ProviderMessageType'
      additionalProperties: false
    Field:
      type: object
      properties:
        order:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        label:
          type:
          - string
          - 'null'
        unit:
          type:
          - string
          - 'null'
        helpText:
          type:
          - string
          - 'null'
        helpTextWarning:
          type:
          - string
          - 'null'
        helpLink:
          type:
          - string
          - 'null'
        value: {}
        type:
          type:
          - string
          - 'null'
        advanced:
          type: boolean
        selectOptions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SelectOption'
        selectOptionsProviderAction:
          type:
          - string
          - 'null'
        section:
          type:
          - string
          - 'null'
        hidden:
          type:
          - string
          - 'null'
        privacy:
          $ref: '#/components/schemas/PrivacyLevel'
        placeholder:
          type:
          - string
          - 'null'
        isFloat:
          type: boolean
      additionalProperties: false
    SelectOption:
      type: object
      properties:
        value:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        order:
          type: integer
          format: int32
        hint:
          type:
          - string
          - 'null'
        parentValue:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
  securitySchemes:
    X-Api-Key:
      type: apiKey
      description: Apikey passed as header
      name: X-Api-Key
      in: header
    apikey:
      type: apiKey
      description: Apikey passed as query parameter
      name: apikey
      in: query