Prowlarr

Prowlarr Indexer API

The Indexer API from Prowlarr — 7 operation(s) for indexer.

GitHub OpenAPI
Business capability
Self-Hosted Media Servers & Library Automation AE-170.90

Operations 11

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

Specifications

⚙
OpenAPI
https://artifacts.apis.io/prowlarr/openapi/prowlarr-indexer-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-indexer-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-indexer-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Prowlarr Indexer 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: Indexer
paths:
  /api/v1/indexer/{id}:
    get:
      tags:
      - Indexer
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexerResource'
      summary: Get api indexer by id
      x-summary-source: derived
      operationId: getApiV1IndexerById
      x-operation-id-source: derived
    put:
      tags:
      - Indexer
      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/IndexerResource'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexerResource'
      summary: Replace api indexer by id
      x-summary-source: derived
      operationId: putApiV1IndexerById
      x-operation-id-source: derived
    delete:
      tags:
      - Indexer
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
      summary: Delete api indexer by id
      x-summary-source: derived
      operationId: deleteApiV1IndexerById
      x-operation-id-source: derived
  /api/v1/indexer:
    get:
      tags:
      - Indexer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexerResource'
      summary: Get api indexer
      x-summary-source: derived
      operationId: getApiV1Indexer
      x-operation-id-source: derived
    post:
      tags:
      - Indexer
      parameters:
      - name: forceSave
        in: query
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndexerResource'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexerResource'
      summary: Create api indexer
      x-summary-source: derived
      operationId: postApiV1Indexer
      x-operation-id-source: derived
  /api/v1/indexer/bulk:
    put:
      tags:
      - Indexer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndexerBulkResource'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexerResource'
      summary: Replace api indexer bulk
      x-summary-source: derived
      operationId: putApiV1IndexerBulk
      x-operation-id-source: derived
    delete:
      tags:
      - Indexer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndexerBulkResource'
      responses:
        '200':
          description: OK
      summary: Delete api indexer bulk
      x-summary-source: derived
      operationId: deleteApiV1IndexerBulk
      x-operation-id-source: derived
  /api/v1/indexer/schema:
    get:
      tags:
      - Indexer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexerResource'
      summary: Get api indexer schema
      x-summary-source: derived
      operationId: getApiV1IndexerSchema
      x-operation-id-source: derived
  /api/v1/indexer/test:
    post:
      tags:
      - Indexer
      parameters:
      - name: forceTest
        in: query
        schema:
          type: boolean
          default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndexerResource'
      responses:
        '200':
          description: OK
      summary: Create api indexer test
      x-summary-source: derived
      operationId: postApiV1IndexerTest
      x-operation-id-source: derived
  /api/v1/indexer/testall:
    post:
      tags:
      - Indexer
      responses:
        '200':
          description: OK
      summary: Create api indexer testall
      x-summary-source: derived
      operationId: postApiV1IndexerTestall
      x-operation-id-source: derived
  /api/v1/indexer/action/{name}:
    post:
      tags:
      - Indexer
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndexerResource'
      responses:
        '200':
          description: OK
      summary: Create api indexer action by name
      x-summary-source: derived
      operationId: postApiV1IndexerActionByName
      x-operation-id-source: derived
components:
  schemas:
    TvSearchParam:
      enum:
      - q
      - season
      - ep
      - imdbId
      - tvdbId
      - rId
      - tvMazeId
      - traktId
      - tmdbId
      - doubanId
      - genre
      - year
      type: string
    IndexerCategory:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        subCategories:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IndexerCategory'
          readOnly: true
      additionalProperties: false
    IndexerBulkResource:
      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'
        appProfileId:
          type:
          - integer
          - 'null'
          format: int32
        priority:
          type:
          - integer
          - 'null'
          format: int32
        minimumSeeders:
          type:
          - integer
          - 'null'
          format: int32
        seedRatio:
          type:
          - number
          - 'null'
          format: double
        seedTime:
          type:
          - integer
          - 'null'
          format: int32
        packSeedTime:
          type:
          - integer
          - 'null'
          format: int32
        preferMagnetUrl:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    ApplyTags:
      enum:
      - add
      - remove
      - replace
      type: string
    PrivacyLevel:
      enum:
      - normal
      - password
      - apiKey
      - userName
      type: string
    SearchParam:
      enum:
      - q
      type: string
    IndexerStatusResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        indexerId:
          type: integer
          format: int32
        disabledTill:
          type:
          - string
          - 'null'
          format: date-time
        mostRecentFailure:
          type:
          - string
          - 'null'
          format: date-time
        initialFailure:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    DownloadProtocol:
      enum:
      - unknown
      - usenet
      - torrent
      type: string
    ProviderMessageType:
      enum:
      - info
      - warning
      - error
      type: string
    IndexerCapabilityResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        limitsMax:
          type:
          - integer
          - 'null'
          format: int32
        limitsDefault:
          type:
          - integer
          - 'null'
          format: int32
        categories:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IndexerCategory'
        supportsRawSearch:
          type: boolean
        searchParams:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SearchParam'
        tvSearchParams:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/TvSearchParam'
        movieSearchParams:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MovieSearchParam'
        musicSearchParams:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/MusicSearchParam'
        bookSearchParams:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BookSearchParam'
      additionalProperties: false
    MovieSearchParam:
      enum:
      - q
      - imdbId
      - tmdbId
      - imdbTitle
      - imdbYear
      - traktId
      - genre
      - doubanId
      - year
      type: string
    MusicSearchParam:
      enum:
      - q
      - album
      - artist
      - label
      - year
      - genre
      - track
      type: string
    ProviderMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/ProviderMessageType'
      additionalProperties: false
    BookSearchParam:
      enum:
      - q
      - title
      - author
      - publisher
      - genre
      - year
      type: string
    IndexerPrivacy:
      enum:
      - public
      - semiPrivate
      - private
      type: string
    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
    IndexerResource:
      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/IndexerResource'
        indexerUrls:
          type:
          - array
          - 'null'
          items:
            type: string
        legacyUrls:
          type:
          - array
          - 'null'
          items:
            type: string
        definitionName:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        language:
          type:
          - string
          - 'null'
        encoding:
          type:
          - string
          - 'null'
        enable:
          type: boolean
        redirect:
          type: boolean
        supportsRss:
          type: boolean
        supportsSearch:
          type: boolean
        supportsRedirect:
          type: boolean
        supportsPagination:
          type: boolean
        appProfileId:
          type: integer
          format: int32
        protocol:
          $ref: '#/components/schemas/DownloadProtocol'
        privacy:
          $ref: '#/components/schemas/IndexerPrivacy'
        capabilities:
          $ref: '#/components/schemas/IndexerCapabilityResource'
        priority:
          type: integer
          format: int32
        downloadClientId:
          type: integer
          format: int32
        added:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/IndexerStatusResource'
        sortName:
          type:
          - string
          - 'null'
      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