Sonarr

Sonarr Connection API

The Connection API from Sonarr — 6 operation(s) for connection.

GitHub OpenAPI

Operations 9

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

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sonarr/openapi/sonarr-connection-api-openapi.yml

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/sonarr:sonarr-connection-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.

GitHub Google LinkedIn

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

OpenAPI Specification

sonarr-connection-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sonarr Connection 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: Connection
paths:
  /api/v5/connection:
    get:
      tags:
      - Connection
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConnectionResource'
      summary: Get api connection
      x-summary-source: derived
      operationId: getApiV5Connection
      x-operation-id-source: derived
    post:
      tags:
      - Connection
      parameters:
      - name: skipTesting
        in: query
        schema:
          type: boolean
          default: false
      - name: skipValidation
        in: query
        schema:
          $ref: '#/components/schemas/SkipValidation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionResource'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionResource'
        '404':
          description: Not Found
      summary: Create api connection
      x-summary-source: derived
      operationId: postApiV5Connection
      x-operation-id-source: derived
  /api/v5/connection/{id}:
    put:
      tags:
      - Connection
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: skipTesting
        in: query
        schema:
          type: boolean
          default: false
      - name: skipValidation
        in: query
        schema:
          $ref: '#/components/schemas/SkipValidation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionResource'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionResource'
        '404':
          description: Not Found
      summary: Replace api connection by id
      x-summary-source: derived
      operationId: putApiV5ConnectionById
      x-operation-id-source: derived
    delete:
      tags:
      - Connection
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: No Content
      summary: Delete api connection by id
      x-summary-source: derived
      operationId: deleteApiV5ConnectionById
      x-operation-id-source: derived
    get:
      tags:
      - Connection
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionResource'
        '404':
          description: Not Found
      summary: Get api connection by id
      x-summary-source: derived
      operationId: getApiV5ConnectionById
      x-operation-id-source: derived
  /api/v5/connection/schema:
    get:
      tags:
      - Connection
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConnectionResource'
      summary: Get api connection schema
      x-summary-source: derived
      operationId: getApiV5ConnectionSchema
      x-operation-id-source: derived
  /api/v5/connection/test:
    post:
      tags:
      - Connection
      parameters:
      - name: skipValidation
        in: query
        schema:
          $ref: '#/components/schemas/SkipValidation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionResource'
      responses:
        '204':
          description: No Content
      summary: Create api connection test
      x-summary-source: derived
      operationId: postApiV5ConnectionTest
      x-operation-id-source: derived
  /api/v5/connection/testall:
    post:
      tags:
      - Connection
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProviderTestAllResult'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProviderTestAllResult'
      summary: Create api connection testall
      x-summary-source: derived
      operationId: postApiV5ConnectionTestall
      x-operation-id-source: derived
  /api/v5/connection/action/{name}:
    post:
      tags:
      - Connection
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionResource'
      responses:
        '400':
          description: Bad Request
      summary: Create api connection action by name
      x-summary-source: derived
      operationId: postApiV5ConnectionActionByName
      x-operation-id-source: derived
components:
  schemas:
    SkipValidation:
      enum:
      - none
      - warnings
      - all
      type: string
    ProviderTestAllResult:
      type: object
      properties:
        id:
          type: integer
          format: int32
        isValid:
          type: boolean
          readOnly: true
        validationFailures:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationFailure'
      additionalProperties: false
    ConnectionResource:
      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/ConnectionResource'
        link:
          type:
          - string
          - 'null'
        onGrab:
          type: boolean
        onDownload:
          type: boolean
        onUpgrade:
          type: boolean
        onImportComplete:
          type: boolean
        onRename:
          type: boolean
        onSeriesAdd:
          type: boolean
        onSeriesDelete:
          type: boolean
        onEpisodeFileDelete:
          type: boolean
        onEpisodeFileDeleteForUpgrade:
          type: boolean
        onHealthIssue:
          type: boolean
        includeHealthWarnings:
          type: boolean
        onHealthRestored:
          type: boolean
        onApplicationUpdate:
          type: boolean
        onManualInteractionRequired:
          type: boolean
        supportsOnGrab:
          type: boolean
        supportsOnDownload:
          type: boolean
        supportsOnUpgrade:
          type: boolean
        supportsOnImportComplete:
          type: boolean
        supportsOnRename:
          type: boolean
        supportsOnSeriesAdd:
          type: boolean
        supportsOnSeriesDelete:
          type: boolean
        supportsOnEpisodeFileDelete:
          type: boolean
        supportsOnEpisodeFileDeleteForUpgrade:
          type: boolean
        supportsOnHealthIssue:
          type: boolean
        supportsOnHealthRestored:
          type: boolean
        supportsOnApplicationUpdate:
          type: boolean
        supportsOnManualInteractionRequired:
          type: boolean
        testCommand:
          type:
          - string
          - 'null'
      additionalProperties: false
    Severity:
      enum:
      - error
      - warning
      - info
      type: string
    PrivacyLevel:
      enum:
      - normal
      - password
      - apiKey
      - userName
      type: string
    SelectOption:
      type: object
      properties:
        value:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        order:
          type: integer
          format: int32
        hint:
          type:
          - string
          - 'null'
      additionalProperties: false
    ValidationFailure:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        customState: {}
        severity:
          $ref: '#/components/schemas/Severity'
        errorCode:
          type:
          - string
          - 'null'
        formattedMessageArguments:
          type:
          - array
          - 'null'
          items: {}
          deprecated: true
        formattedMessagePlaceholderValues:
          type:
          - object
          - 'null'
          additionalProperties: {}
      additionalProperties: false
    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
    ProviderMessageType:
      enum:
      - info
      - warning
      - error
      type: string
    ProviderMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/ProviderMessageType'
      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