Sonarr General Settings API
The GeneralSettings API from Sonarr — 2 operation(s) for generalsettings.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/sonarr:sonarr-generalsettings-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.
OpenAPI Specification
openapi: 3.2.0
info:
title: Sonarr General Settings API
description: Sonarr API docs - The v5 API docs apply to Sonarr v5 only.
license:
name: GPL-3.0
url: https://github.com/Sonarr/Sonarr/blob/develop/LICENSE
version: 5.0.0
servers:
- url: '{protocol}://{hostpath}'
variables:
protocol:
default: http
enum:
- http
- https
hostpath:
default: localhost:8989
security:
- X-Api-Key: []
- apikey: []
tags:
- name: GeneralSettings
paths:
/api/v5/settings/general/{id}:
put:
tags:
- GeneralSettings
parameters:
- name: id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GeneralSettingsResource'
responses:
'202':
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/GeneralSettingsResource'
'404':
description: Not Found
summary: Replace api settings general by id
x-summary-source: derived
operationId: putApiV5SettingsGeneralById
x-operation-id-source: derived
get:
tags:
- GeneralSettings
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GeneralSettingsResource'
'404':
description: Not Found
summary: Get api settings general by id
x-summary-source: derived
operationId: getApiV5SettingsGeneralById
x-operation-id-source: derived
/api/v5/settings/general:
get:
tags:
- GeneralSettings
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GeneralSettingsResource'
summary: Get api settings general
x-summary-source: derived
operationId: getApiV5SettingsGeneral
x-operation-id-source: derived
components:
schemas:
AuthenticationType:
enum:
- none
- basic
- forms
- external
- oidc
type: string
CertificateValidationType:
enum:
- enabled
- disabledForLocalAddresses
- disabled
type: string
ProxyType:
enum:
- http
- socks4
- socks5
type: string
AuthenticationRequiredType:
enum:
- enabled
- disabledForLocalAddresses
- disabledForLocalhost
type: string
UpdateMechanism:
enum:
- builtIn
- script
- external
- apt
- docker
type: string
GeneralSettingsResource:
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'
allowedHosts:
type:
- string
- 'null'
analyticsEnabled:
type: boolean
username:
type:
- string
- 'null'
password:
type:
- string
- 'null'
passwordConfirmation:
type:
- string
- 'null'
oidcAuthority:
type:
- string
- 'null'
oidcClientId:
type:
- string
- 'null'
oidcClientSecret:
type:
- string
- 'null'
oidcUserIdentifier:
type:
- string
- 'null'
oidcScopes:
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'
sslKeyPath:
type:
- string
- 'null'
sslCertPassword:
type:
- string
- 'null'
urlBase:
type:
- string
- 'null'
trustedNetworks:
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
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