Prowlarr · Schema

HostConfigResource

SoftwareIndexingMedia ManagementOpen SourceAPI

Properties

Name Type Description
id integer
bindAddress stringnull
port integer
sslPort integer
enableSsl boolean
launchBrowser boolean
authenticationMethod object
authenticationRequired object
analyticsEnabled boolean
username stringnull
password stringnull
passwordConfirmation stringnull
logLevel stringnull
logSizeLimit integer
consoleLogLevel stringnull
branch stringnull
apiKey stringnull
sslCertPath stringnull
sslCertPassword stringnull
urlBase stringnull
instanceName stringnull
applicationUrl stringnull
updateAutomatically boolean
updateMechanism object
updateScriptPath stringnull
proxyEnabled boolean
proxyType object
proxyHostname stringnull
proxyPort integer
proxyUsername stringnull
proxyPassword stringnull
proxyBypassFilter stringnull
proxyBypassLocalAddresses boolean
certificateValidation object
backupFolder stringnull
backupInterval integer
backupRetention integer
historyCleanupDays integer
trustCgnatIpAddresses boolean
View JSON Schema on GitHub

JSON Schema

prowlarr-host-config-resource-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/prowlarr/json-schema/prowlarr-host-config-resource-schema.json",
  "title": "HostConfigResource",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/prowlarr-openapi.json#/components/schemas/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": "#/$defs/AuthenticationType"
    },
    "authenticationRequired": {
      "$ref": "#/$defs/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": "#/$defs/UpdateMechanism"
    },
    "updateScriptPath": {
      "type": [
        "string",
        "null"
      ]
    },
    "proxyEnabled": {
      "type": "boolean"
    },
    "proxyType": {
      "$ref": "#/$defs/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": "#/$defs/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,
  "$defs": {
    "AuthenticationRequiredType": {
      "enum": [
        "enabled",
        "disabledForLocalAddresses"
      ],
      "type": "string"
    },
    "AuthenticationType": {
      "enum": [
        "none",
        "basic",
        "forms",
        "external"
      ],
      "type": "string"
    },
    "CertificateValidationType": {
      "enum": [
        "enabled",
        "disabledForLocalAddresses",
        "disabled"
      ],
      "type": "string"
    },
    "ProxyType": {
      "enum": [
        "http",
        "socks4",
        "socks5"
      ],
      "type": "string"
    },
    "UpdateMechanism": {
      "enum": [
        "builtIn",
        "script",
        "external",
        "apt",
        "docker"
      ],
      "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-host-config-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.

GitHub Google LinkedIn

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