Prowlarr · Schema

IndexerResource

SoftwareIndexingMedia ManagementOpen SourceAPI

Properties

Name Type Description
id integer
name stringnull
fields arraynull
implementationName stringnull
implementation stringnull
configContract stringnull
infoLink stringnull
message object
tags arraynull
presets arraynull
indexerUrls arraynull
legacyUrls arraynull
definitionName stringnull
description stringnull
language stringnull
encoding stringnull
enable boolean
redirect boolean
supportsRss boolean
supportsSearch boolean
supportsRedirect boolean
supportsPagination boolean
appProfileId integer
protocol object
privacy object
capabilities object
priority integer
downloadClientId integer
added string
status object
sortName stringnull
View JSON Schema on GitHub

JSON Schema

prowlarr-indexer-resource-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/prowlarr/json-schema/prowlarr-indexer-resource-schema.json",
  "title": "IndexerResource",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/prowlarr-openapi.json#/components/schemas/IndexerResource",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": [
        "string",
        "null"
      ]
    },
    "fields": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/Field"
      }
    },
    "implementationName": {
      "type": [
        "string",
        "null"
      ]
    },
    "implementation": {
      "type": [
        "string",
        "null"
      ]
    },
    "configContract": {
      "type": [
        "string",
        "null"
      ]
    },
    "infoLink": {
      "type": [
        "string",
        "null"
      ]
    },
    "message": {
      "$ref": "#/$defs/ProviderMessage"
    },
    "tags": {
      "uniqueItems": true,
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "integer",
        "format": "int32"
      }
    },
    "presets": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/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": "#/$defs/DownloadProtocol"
    },
    "privacy": {
      "$ref": "#/$defs/IndexerPrivacy"
    },
    "capabilities": {
      "$ref": "#/$defs/IndexerCapabilityResource"
    },
    "priority": {
      "type": "integer",
      "format": "int32"
    },
    "downloadClientId": {
      "type": "integer",
      "format": "int32"
    },
    "added": {
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "$ref": "#/$defs/IndexerStatusResource"
    },
    "sortName": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "additionalProperties": false,
  "$defs": {
    "BookSearchParam": {
      "enum": [
        "q",
        "title",
        "author",
        "publisher",
        "genre",
        "year"
      ],
      "type": "string"
    },
    "DownloadProtocol": {
      "enum": [
        "unknown",
        "usenet",
        "torrent"
      ],
      "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": {
          "nullable": true
        },
        "type": {
          "type": [
            "string",
            "null"
          ]
        },
        "advanced": {
          "type": "boolean"
        },
        "selectOptions": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/SelectOption"
          }
        },
        "selectOptionsProviderAction": {
          "type": [
            "string",
            "null"
          ]
        },
        "section": {
          "type": [
            "string",
            "null"
          ]
        },
        "hidden": {
          "type": [
            "string",
            "null"
          ]
        },
        "privacy": {
          "$ref": "#/$defs/PrivacyLevel"
        },
        "placeholder": {
          "type": [
            "string",
            "null"
          ]
        },
        "isFloat": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "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": "#/$defs/IndexerCategory"
          }
        },
        "supportsRawSearch": {
          "type": "boolean"
        },
        "searchParams": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/SearchParam"
          }
        },
        "tvSearchParams": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/TvSearchParam"
          }
        },
        "movieSearchParams": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/MovieSearchParam"
          }
        },
        "musicSearchParams": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/MusicSearchParam"
          }
        },
        "bookSearchParams": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/BookSearchParam"
          }
        }
      },
      "additionalProperties": false
    },
    "IndexerCategory": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "subCategories": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/IndexerCategory"
          },
          "readOnly": true
        }
      },
      "additionalProperties": false
    },
    "IndexerPrivacy": {
      "enum": [
        "public",
        "semiPrivate",
        "private"
      ],
      "type": "string"
    },
    "IndexerResource": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "fields": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/Field"
          }
        },
        "implementationName": {
          "type": [
            "string",
            "null"
          ]
        },
        "implementation": {
          "type": [
            "string",
            "null"
          ]
        },
        "configContract": {
          "type": [
            "string",
            "null"
          ]
        },
        "infoLink": {
          "type": [
            "string",
            "null"
          ]
        },
        "message": {
          "$ref": "#/$defs/ProviderMessage"
        },
        "tags": {
          "uniqueItems": true,
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "integer",
            "format": "int32"
          }
        },
        "presets": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/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": "#/$defs/DownloadProtocol"
        },
        "privacy": {
          "$ref": "#/$defs/IndexerPrivacy"
        },
        "capabilities": {
          "$ref": "#/$defs/IndexerCapabilityResource"
        },
        "priority": {
          "type": "integer",
          "format": "int32"
        },
        "downloadClientId": {
          "type": "integer",
          "format": "int32"
        },
        "added": {
          "type": "string",
          "format": "date-time"
        },
        "status": {
          "$ref": "#/$defs/IndexerStatusResource"
        },
        "sortName": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "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
    },
    "MovieSearchParam": {
      "enum": [
        "q",
        "imdbId",
        "tmdbId",
        "imdbTitle",
        "imdbYear",
        "traktId",
        "genre",
        "doubanId",
        "year"
      ],
      "type": "string"
    },
    "MusicSearchParam": {
      "enum": [
        "q",
        "album",
        "artist",
        "label",
        "year",
        "genre",
        "track"
      ],
      "type": "string"
    },
    "PrivacyLevel": {
      "enum": [
        "normal",
        "password",
        "apiKey",
        "userName"
      ],
      "type": "string"
    },
    "ProviderMessage": {
      "type": "object",
      "properties": {
        "message": {
          "type": [
            "string",
            "null"
          ]
        },
        "type": {
          "$ref": "#/$defs/ProviderMessageType"
        }
      },
      "additionalProperties": false
    },
    "ProviderMessageType": {
      "enum": [
        "info",
        "warning",
        "error"
      ],
      "type": "string"
    },
    "SearchParam": {
      "enum": [
        "q"
      ],
      "type": "string"
    },
    "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
    },
    "TvSearchParam": {
      "enum": [
        "q",
        "season",
        "ep",
        "imdbId",
        "tvdbId",
        "rId",
        "tvMazeId",
        "traktId",
        "tmdbId",
        "doubanId",
        "genre",
        "year"
      ],
      "type": "string"
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/prowlarr-indexer-resource"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.