Sonarr

Sonarr Backup API

The Backup API from Sonarr — 8 operation(s) for backup.

GitHub OpenAPI

Operations 8

GET /api/v3/system/backup Get api system backup #
DELETE /api/v3/system/backup/{id} Delete api system backup by id #
POST /api/v3/system/backup/restore/{id} Create api system backup restore by id #
POST /api/v3/system/backup/restore/upload Create api system backup restore upload #
GET /api/v5/system/backup Get api system backup #
DELETE /api/v5/system/backup/{id} Delete api system backup by id #
POST /api/v5/system/backup/restore/{id} Create api system backup restore by id #
POST /api/v5/system/backup/restore/upload Create api system backup restore upload #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sonarr/openapi/sonarr-backup-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-backup-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-backup-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sonarr Backup API
  license:
    name: GPL-3.0
    url: https://github.com/Sonarr/Sonarr/blob/develop/LICENSE
  version: '1.0'
  description: 'Operations tagged Backup 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: Backup
paths:
  /api/v3/system/backup:
    get:
      tags:
      - Backup
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BackupResource'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BackupResource'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BackupResource'
      summary: Get api system backup
      x-summary-source: derived
      operationId: getApiV3SystemBackup
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v3/system/backup/{id}:
    delete:
      tags:
      - Backup
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
      summary: Delete api system backup by id
      x-summary-source: derived
      operationId: deleteApiV3SystemBackupById
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v3/system/backup/restore/{id}:
    post:
      tags:
      - Backup
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
      summary: Create api system backup restore by id
      x-summary-source: derived
      operationId: postApiV3SystemBackupRestoreById
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v3/system/backup/restore/upload:
    post:
      tags:
      - Backup
      responses:
        '200':
          description: OK
      summary: Create api system backup restore upload
      x-summary-source: derived
      operationId: postApiV3SystemBackupRestoreUpload
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/system/backup:
    get:
      tags:
      - Backup
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BackupResource_2'
      summary: Get api system backup
      x-summary-source: derived
      operationId: getApiV5SystemBackup
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/system/backup/{id}:
    delete:
      tags:
      - Backup
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: No Content
        '404':
          description: Not Found
      summary: Delete api system backup by id
      x-summary-source: derived
      operationId: deleteApiV5SystemBackupById
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/system/backup/restore/{id}:
    post:
      tags:
      - Backup
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupRestoreResource'
        '404':
          description: Not Found
      summary: Create api system backup restore by id
      x-summary-source: derived
      operationId: postApiV5SystemBackupRestoreById
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/system/backup/restore/upload:
    post:
      tags:
      - Backup
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupRestoreResource'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackupRestoreErrorResource'
      summary: Create api system backup restore upload
      x-summary-source: derived
      operationId: postApiV5SystemBackupRestoreUpload
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
components:
  schemas:
    BackupResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        path:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/BackupType'
        size:
          type: integer
          format: int64
        time:
          type: string
          format: date-time
      additionalProperties: false
    BackupType:
      enum:
      - scheduled
      - manual
      - update
      type: string
    BackupResource_2:
      required:
      - name
      - path
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        path:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/BackupType'
        size:
          type: integer
          format: int64
        time:
          type: string
          format: date-time
      additionalProperties: false
    BackupRestoreErrorResource:
      type: object
      properties:
        error:
          type:
          - string
          - 'null'
      additionalProperties: false
    BackupRestoreResource:
      type: object
      properties:
        restartRequired:
          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