Sonarr

Sonarr Command API

The Command API from Sonarr — 4 operation(s) for command.

Documentation GitHub OpenAPI

Operations 8

POST /api/v3/command Create api command #

GET /api/v3/command Get api command #

DELETE /api/v3/command/{id} Delete api command by id #

GET /api/v3/command/{id} Get api command by id #

POST /api/v5/command Create api command #

GET /api/v5/command Get api command #

DELETE /api/v5/command/{id} Delete api command by id #

GET /api/v5/command/{id} Get api command by id #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/sonarr/openapi/sonarr-command-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-command-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 Command API
  license:
    name: GPL-3.0
    url: https://github.com/Sonarr/Sonarr/blob/develop/LICENSE
  version: '1.0'
  description: 'Operations tagged Command 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: Command
paths:
  /api/v3/command:
    post:
      tags:
      - Command
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommandResource'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommandResource'
      summary: Create api command
      x-summary-source: derived
      operationId: postApiV3Command
      x-operation-id-source: derived
    get:
      tags:
      - Command
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CommandResource'
      summary: Get api command
      x-summary-source: derived
      operationId: getApiV3Command
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v3/command/{id}:
    delete:
      tags:
      - Command
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
      summary: Delete api command by id
      x-summary-source: derived
      operationId: deleteApiV3CommandById
      x-operation-id-source: derived
    get:
      tags:
      - Command
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommandResource'
        '404':
          description: Not Found
      summary: Get api command by id
      x-summary-source: derived
      operationId: getApiV3CommandById
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/command:
    post:
      tags:
      - Command
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommandResource'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommandResource'
        '404':
          description: Not Found
      summary: Create api command
      x-summary-source: derived
      operationId: postApiV5Command
      x-operation-id-source: derived
    get:
      tags:
      - Command
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CommandResource'
      summary: Get api command
      x-summary-source: derived
      operationId: getApiV5Command
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/command/{id}:
    delete:
      tags:
      - Command
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: No Content
      summary: Delete api command by id
      x-summary-source: derived
      operationId: deleteApiV5CommandById
      x-operation-id-source: derived
    get:
      tags:
      - Command
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommandResource'
        '404':
          description: Not Found
      summary: Get api command by id
      x-summary-source: derived
      operationId: getApiV5CommandById
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
components:
  schemas:
    CommandPriority:
      enum:
      - normal
      - high
      - low
      type: string
    CommandResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        commandName:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
        body:
          $ref: '#/components/schemas/Command'
        priority:
          $ref: '#/components/schemas/CommandPriority'
        status:
          $ref: '#/components/schemas/CommandStatus'
        result:
          $ref: '#/components/schemas/CommandResult'
        queued:
          type: string
          format: date-time
        started:
          type:
          - string
          - 'null'
          format: date-time
        ended:
          type:
          - string
          - 'null'
          format: date-time
        duration:
          type:
          - string
          - 'null'
          format: date-span
        exception:
          type:
          - string
          - 'null'
        trigger:
          $ref: '#/components/schemas/CommandTrigger'
        clientUserAgent:
          type:
          - string
          - 'null'
        stateChangeTime:
          type:
          - string
          - 'null'
          format: date-time
        sendUpdatesToClient:
          type: boolean
        updateScheduledTask:
          type: boolean
        lastExecutionTime:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    CommandStatus:
      enum:
      - queued
      - started
      - completed
      - failed
      - aborted
      - cancelled
      - orphaned
      type: string
    CommandResult:
      enum:
      - unknown
      - successful
      - unsuccessful
      - indeterminate
      type: string
    Command:
      type: object
      properties:
        sendUpdatesToClient:
          type: boolean
        updateScheduledTask:
          type: boolean
          readOnly: true
        completionMessage:
          type:
          - string
          - 'null'
          readOnly: true
        requiresDiskAccess:
          type: boolean
          readOnly: true
        isExclusive:
          type: boolean
          readOnly: true
        isLongRunning:
          type: boolean
          readOnly: true
        name:
          type:
          - string
          - 'null'
          readOnly: true
        lastExecutionTime:
          type:
          - string
          - 'null'
          format: date-time
        lastStartTime:
          type:
          - string
          - 'null'
          format: date-time
        trigger:
          $ref: '#/components/schemas/CommandTrigger'
        suppressMessages:
          type: boolean
        clientUserAgent:
          type:
          - string
          - 'null'
      additionalProperties: false
    CommandTrigger:
      enum:
      - unspecified
      - manual
      - scheduled
      type: string
  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