Prowlarr

Prowlarr Host Config API

The HostConfig API from Prowlarr — 2 operation(s) for hostconfig.

GitHub OpenAPI

Operations 3

GET /api/v1/config/host/{id} Get api config host by id #
PUT /api/v1/config/host/{id} Replace api config host by id #
GET /api/v1/config/host Get api config host #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/prowlarr/openapi/prowlarr-hostconfig-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-hostconfig-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-hostconfig-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Prowlarr Host Config 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: HostConfig
paths:
  /api/v1/config/host/{id}:
    get:
      tags:
      - HostConfig
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostConfigResource'
      summary: Get api config host by id
      x-summary-source: derived
      operationId: getApiV1ConfigHostById
      x-operation-id-source: derived
    put:
      tags:
      - HostConfig
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HostConfigResource'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostConfigResource'
      summary: Replace api config host by id
      x-summary-source: derived
      operationId: putApiV1ConfigHostById
      x-operation-id-source: derived
  /api/v1/config/host:
    get:
      tags:
      - HostConfig
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostConfigResource'
      summary: Get api config host
      x-summary-source: derived
      operationId: getApiV1ConfigHost
      x-operation-id-source: derived
components:
  schemas:
    ProxyType:
      enum:
      - http
      - socks4
      - socks5
      type: string
    UpdateMechanism:
      enum:
      - builtIn
      - script
      - external
      - apt
      - docker
      type: string
    HostConfigResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        bindAddress:
          type:
          - string
          - 'null'
        port:
          type: integer
          format: int32
        sslPort:
          type: integer
          format: int32
        enableSsl:
          type: boolean
        launchBrowser:
          type: boolean
        authenticationMethod:
          $ref: '#/components/schemas/AuthenticationType'
        authenticationRequired:
          $ref: '#/components/schemas/AuthenticationRequiredType'
        analyticsEnabled:
          type: boolean
        username:
          type:
          - string
          - 'null'
        password:
          type:
          - string
          - 'null'
        passwordConfirmation:
          type:
          - string
          - 'null'
        logLevel:
          type:
          - string
          - 'null'
        logSizeLimit:
          type: integer
          format: int32
        consoleLogLevel:
          type:
          - string
          - 'null'
        branch:
          type:
          - string
          - 'null'
        apiKey:
          type:
          - string
          - 'null'
        sslCertPath:
          type:
          - string
          - 'null'
        sslCertPassword:
          type:
          - string
          - 'null'
        urlBase:
          type:
          - string
          - 'null'
        instanceName:
          type:
          - string
          - 'null'
        applicationUrl:
          type:
          - string
          - 'null'
        updateAutomatically:
          type: boolean
        updateMechanism:
          $ref: '#/components/schemas/UpdateMechanism'
        updateScriptPath:
          type:
          - string
          - 'null'
        proxyEnabled:
          type: boolean
        proxyType:
          $ref: '#/components/schemas/ProxyType'
        proxyHostname:
          type:
          - string
          - 'null'
        proxyPort:
          type: integer
          format: int32
        proxyUsername:
          type:
          - string
          - 'null'
        proxyPassword:
          type:
          - string
          - 'null'
        proxyBypassFilter:
          type:
          - string
          - 'null'
        proxyBypassLocalAddresses:
          type: boolean
        certificateValidation:
          $ref: '#/components/schemas/CertificateValidationType'
        backupFolder:
          type:
          - string
          - 'null'
        backupInterval:
          type: integer
          format: int32
        backupRetention:
          type: integer
          format: int32
        historyCleanupDays:
          type: integer
          format: int32
        trustCgnatIpAddresses:
          type: boolean
      additionalProperties: false
    CertificateValidationType:
      enum:
      - enabled
      - disabledForLocalAddresses
      - disabled
      type: string
    AuthenticationRequiredType:
      enum:
      - enabled
      - disabledForLocalAddresses
      type: string
    AuthenticationType:
      enum:
      - none
      - basic
      - forms
      - external
      type: string
  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