Sonarr

Sonarr Health API

The Health API from Sonarr — 2 operation(s) for health.

Documentation GitHub OpenAPI

Operations 2

GET /api/v3/health Get api health #

GET /api/v5/health Get api health #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/sonarr/openapi/sonarr-health-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-health-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

openapi: 3.2.0
info:
  title: Sonarr Health API
  license:
    name: GPL-3.0
    url: https://github.com/Sonarr/Sonarr/blob/develop/LICENSE
  version: '1.0'
  description: 'Operations tagged Health across 2 of this provider''s published API definitions: openapi_v3.json, openapi_v5.json. Each path carries the servers of the definition it was published in.'
servers:
- url: '{protocol}://{hostpath}'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    hostpath:
      default: localhost:8989
security:
- X-Api-Key: []
- apikey: []
tags:
- name: Health
paths:
  /api/v3/health:
    get:
      tags:
      - Health
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HealthResource'
      summary: Get api health
      x-summary-source: derived
      operationId: getApiV3Health
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/health:
    get:
      tags:
      - Health
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/HealthResource_2'
      summary: Get api health
      x-summary-source: derived
      operationId: getApiV5Health
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
components:
  schemas:
    HealthResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        source:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/HealthCheckResult'
        message:
          type:
          - string
          - 'null'
        wikiUrl:
          type:
          - string
          - 'null'
      additionalProperties: false
    HealthCheckResult:
      enum:
      - ok
      - notice
      - warning
      - error
      type: string
    HealthCheckReason:
      enum:
      - allowedHostsNotConfigured
      - appDataLocation
      - downloadClientCheckNoneAvailable
      - downloadClientCheckUnableToCommunicate
      - downloadClientRemovesCompletedDownloads
      - downloadClientRootFolder
      - downloadClientSorting
      - downloadClientStatusAllClients
      - downloadClientStatusSingleClient
      - importListRootFolderMissing
      - importListRootFolderMultipleMissing
      - importListStatusAllUnavailable
      - importListStatusUnavailable
      - importMechanismEnableCompletedDownloadHandlingIfPossible
      - importMechanismEnableCompletedDownloadHandlingIfPossibleMultiComputer
      - importMechanismHandlingDisabled
      - indexerDownloadClient
      - indexerJackettAll
      - indexerLongTermStatusAllUnavailable
      - indexerLongTermStatusUnavailable
      - indexerRssNoIndexersAvailable
      - indexerRssNoIndexersEnabled
      - indexerSearchNoAutomatic
      - indexerSearchNoAvailableIndexers
      - indexerSearchNoInteractive
      - indexerStatusAllUnavailable
      - indexerStatusUnavailable
      - minimumApiKeyLength
      - mountSeries
      - notificationStatusAll
      - notificationStatusSingle
      - oidcAuthorityNotSecure
      - oidcDiscoveryFailed
      - oidcNotConfigured
      - package
      - passwordResetTokenConfigured
      - proxyBadRequest
      - proxyFailed
      - proxyResolveIp
      - recycleBinUnableToWrite
      - remotePathMappingBadDockerPath
      - remotePathMappingDockerFolderMissing
      - remotePathMappingDownloadPermissionsEpisode
      - remotePathMappingFileRemoved
      - remotePathMappingFilesBadDockerPath
      - remotePathMappingFilesGenericPermissions
      - remotePathMappingFilesLocalWrongOSPath
      - remotePathMappingFilesWrongOSPath
      - remotePathMappingFolderPermissions
      - remotePathMappingGenericPermissions
      - remotePathMappingImportEpisodeFailed
      - remotePathMappingLocalFolderMissing
      - remotePathMappingLocalWrongOSPath
      - remotePathMappingRemoteDownloadClient
      - remotePathMappingWrongOSPath
      - removedSeriesMultiple
      - removedSeriesSingle
      - rootFolderEmpty
      - rootFolderMissing
      - rootFolderMultipleMissing
      - serverNotification
      - systemTime
      - updateAvailable
      - updateStartupNotWritable
      - updateStartupTranslocation
      - updateUiNotWritable
      type: string
    HealthResource_2:
      type: object
      properties:
        id:
          type: integer
          format: int32
        source:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/HealthCheckResult'
        reason:
          $ref: '#/components/schemas/HealthCheckReason'
        message:
          type:
          - string
          - 'null'
        wikiUrl:
          type:
          - string
          - 'null'
      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
x-refined-from:
- openapi_v3.json
- openapi_v5.json