Sonarr

Sonarr System API

The System API from Sonarr — 10 operation(s) for system.

GitHub OpenAPI

Operations 10

GET /api/v3/system/status Get api system status #
GET /api/v3/system/routes Get api system routes #
GET /api/v3/system/routes/duplicate Get api system routes duplicate #
POST /api/v3/system/shutdown Create api system shutdown #
POST /api/v3/system/restart Create api system restart #
GET /api/v5/system/status Get api system status #
GET /api/v5/system/routes Get api system routes #
GET /api/v5/system/routes/duplicate Get api system routes duplicate #
POST /api/v5/system/shutdown Create api system shutdown #
POST /api/v5/system/restart Create api system restart #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sonarr/openapi/sonarr-system-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-system-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-system-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sonarr System API
  license:
    name: GPL-3.0
    url: https://github.com/Sonarr/Sonarr/blob/develop/LICENSE
  version: '1.0'
  description: 'Operations tagged System 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: System
paths:
  /api/v3/system/status:
    get:
      tags:
      - System
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemResource'
      summary: Get api system status
      x-summary-source: derived
      operationId: getApiV3SystemStatus
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v3/system/routes:
    get:
      tags:
      - System
      responses:
        '200':
          description: OK
      summary: Get api system routes
      x-summary-source: derived
      operationId: getApiV3SystemRoutes
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v3/system/routes/duplicate:
    get:
      tags:
      - System
      responses:
        '200':
          description: OK
      summary: Get api system routes duplicate
      x-summary-source: derived
      operationId: getApiV3SystemRoutesDuplicate
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v3/system/shutdown:
    post:
      tags:
      - System
      responses:
        '200':
          description: OK
      summary: Create api system shutdown
      x-summary-source: derived
      operationId: postApiV3SystemShutdown
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v3/system/restart:
    post:
      tags:
      - System
      responses:
        '200':
          description: OK
      summary: Create api system restart
      x-summary-source: derived
      operationId: postApiV3SystemRestart
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/system/status:
    get:
      tags:
      - System
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemResource_2'
      summary: Get api system status
      x-summary-source: derived
      operationId: getApiV5SystemStatus
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/system/routes:
    get:
      tags:
      - System
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
      summary: Get api system routes
      x-summary-source: derived
      operationId: getApiV5SystemRoutes
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/system/routes/duplicate:
    get:
      tags:
      - System
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
      summary: Get api system routes duplicate
      x-summary-source: derived
      operationId: getApiV5SystemRoutesDuplicate
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/system/shutdown:
    post:
      tags:
      - System
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemShutdownResource'
      summary: Create api system shutdown
      x-summary-source: derived
      operationId: postApiV5SystemShutdown
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/system/restart:
    post:
      tags:
      - System
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemRestartResource'
      summary: Create api system restart
      x-summary-source: derived
      operationId: postApiV5SystemRestart
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
components:
  schemas:
    AuthenticationType:
      enum:
      - none
      - basic
      - forms
      - external
      - oidc
      type: string
    DatabaseType:
      enum:
      - sqLite
      - postgreSQL
      type: string
    SystemResource:
      type: object
      properties:
        appName:
          type:
          - string
          - 'null'
        instanceName:
          type:
          - string
          - 'null'
        version:
          type:
          - string
          - 'null'
        buildTime:
          type: string
          format: date-time
        isDebug:
          type: boolean
        isProduction:
          type: boolean
        isAdmin:
          type: boolean
        isUserInteractive:
          type: boolean
        startupPath:
          type:
          - string
          - 'null'
        appData:
          type:
          - string
          - 'null'
        osName:
          type:
          - string
          - 'null'
        osVersion:
          type:
          - string
          - 'null'
        isNetCore:
          type: boolean
        isLinux:
          type: boolean
        isOsx:
          type: boolean
        isWindows:
          type: boolean
        isDocker:
          type: boolean
        isContainerized:
          type: boolean
        mode:
          $ref: '#/components/schemas/RuntimeMode'
        branch:
          type:
          - string
          - 'null'
        authentication:
          $ref: '#/components/schemas/AuthenticationType'
        sqliteVersion:
          type:
          - string
          - 'null'
        migrationVersion:
          type: integer
          format: int32
        urlBase:
          type:
          - string
          - 'null'
        runtimeVersion:
          type:
          - string
          - 'null'
        runtimeName:
          type:
          - string
          - 'null'
        startTime:
          type: string
          format: date-time
        packageVersion:
          type:
          - string
          - 'null'
        packageAuthor:
          type:
          - string
          - 'null'
        packageUpdateMechanism:
          $ref: '#/components/schemas/UpdateMechanism'
        packageUpdateMechanismMessage:
          type:
          - string
          - 'null'
        databaseVersion:
          type:
          - string
          - 'null'
        databaseType:
          $ref: '#/components/schemas/DatabaseType'
      additionalProperties: false
    UpdateMechanism:
      enum:
      - builtIn
      - script
      - external
      - apt
      - docker
      type: string
    RuntimeMode:
      enum:
      - console
      - service
      - tray
      type: string
    SystemResource_2:
      required:
      - appData
      - appName
      - branch
      - databaseVersion
      - instanceName
      - osName
      - osVersion
      - packageAuthor
      - packageUpdateMechanismMessage
      - packageVersion
      - runtimeName
      - runtimeVersion
      - startupPath
      - urlBase
      - version
      type: object
      properties:
        appName:
          type:
          - string
          - 'null'
        instanceName:
          type:
          - string
          - 'null'
        version:
          type:
          - string
          - 'null'
        buildTime:
          type: string
          format: date-time
        isDebug:
          type: boolean
        isProduction:
          type: boolean
        isAdmin:
          type: boolean
        isUserInteractive:
          type: boolean
        startupPath:
          type:
          - string
          - 'null'
        appData:
          type:
          - string
          - 'null'
        osName:
          type:
          - string
          - 'null'
        osVersion:
          type:
          - string
          - 'null'
        isNetCore:
          type: boolean
        isLinux:
          type: boolean
        isOsx:
          type: boolean
        isWindows:
          type: boolean
        isDocker:
          type: boolean
        mode:
          $ref: '#/components/schemas/RuntimeMode'
        branch:
          type:
          - string
          - 'null'
        authentication:
          $ref: '#/components/schemas/AuthenticationType'
        migrationVersion:
          type: integer
          format: int32
        urlBase:
          type:
          - string
          - 'null'
        runtimeVersion:
          type:
          - string
          - 'null'
        runtimeName:
          type:
          - string
          - 'null'
        startTime:
          type: string
          format: date-time
        packageVersion:
          type:
          - string
          - 'null'
        packageAuthor:
          type:
          - string
          - 'null'
        packageUpdateMechanism:
          $ref: '#/components/schemas/UpdateMechanism'
        packageUpdateMechanismMessage:
          type:
          - string
          - 'null'
        databaseVersion:
          type:
          - string
          - 'null'
        databaseType:
          $ref: '#/components/schemas/DatabaseType'
      additionalProperties: false
    SystemRestartResource:
      type: object
      properties:
        restarting:
          type: boolean
      additionalProperties: false
    SystemShutdownResource:
      type: object
      properties:
        shuttingDown:
          type: boolean
      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