Sonarr

Sonarr Custom Format API

The CustomFormat API from Sonarr — 8 operation(s) for customformat.

GitHub OpenAPI

Operations 16

GET /api/v3/customformat Get api customformat #
POST /api/v3/customformat Create api customformat #
PUT /api/v3/customformat/{id} Replace api customformat by id #
DELETE /api/v3/customformat/{id} Delete api customformat by id #
GET /api/v3/customformat/{id} Get api customformat by id #
PUT /api/v3/customformat/bulk Replace api customformat bulk #
DELETE /api/v3/customformat/bulk Delete api customformat bulk #
GET /api/v3/customformat/schema Get api customformat schema #
GET /api/v5/customformat Get api customformat #
POST /api/v5/customformat Create api customformat #
PUT /api/v5/customformat/{id} Replace api customformat by id #
DELETE /api/v5/customformat/{id} Delete api customformat by id #
GET /api/v5/customformat/{id} Get api customformat by id #
PUT /api/v5/customformat/bulk Replace api customformat bulk #
DELETE /api/v5/customformat/bulk Delete api customformat bulk #
GET /api/v5/customformat/schema Get api customformat schema #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sonarr/openapi/sonarr-customformat-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-customformat-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-customformat-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sonarr Custom Format API
  license:
    name: GPL-3.0
    url: https://github.com/Sonarr/Sonarr/blob/develop/LICENSE
  version: '1.0'
  description: 'Operations tagged CustomFormat 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: CustomFormat
paths:
  /api/v3/customformat:
    get:
      tags:
      - CustomFormat
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomFormatResource'
      summary: Get api customformat
      x-summary-source: derived
      operationId: getApiV3Customformat
      x-operation-id-source: derived
    post:
      tags:
      - CustomFormat
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFormatResource'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomFormatResource'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFormatResource'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomFormatResource'
      summary: Create api customformat
      x-summary-source: derived
      operationId: postApiV3Customformat
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v3/customformat/{id}:
    put:
      tags:
      - CustomFormat
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFormatResource'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomFormatResource'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFormatResource'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomFormatResource'
      summary: Replace api customformat by id
      x-summary-source: derived
      operationId: putApiV3CustomformatById
      x-operation-id-source: derived
    delete:
      tags:
      - CustomFormat
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
      summary: Delete api customformat by id
      x-summary-source: derived
      operationId: deleteApiV3CustomformatById
      x-operation-id-source: derived
    get:
      tags:
      - CustomFormat
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFormatResource'
        '404':
          description: Not Found
      summary: Get api customformat by id
      x-summary-source: derived
      operationId: getApiV3CustomformatById
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v3/customformat/bulk:
    put:
      tags:
      - CustomFormat
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFormatBulkResource'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFormatResource'
      summary: Replace api customformat bulk
      x-summary-source: derived
      operationId: putApiV3CustomformatBulk
      x-operation-id-source: derived
    delete:
      tags:
      - CustomFormat
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFormatBulkResource'
      responses:
        '200':
          description: OK
      summary: Delete api customformat bulk
      x-summary-source: derived
      operationId: deleteApiV3CustomformatBulk
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v3/customformat/schema:
    get:
      tags:
      - CustomFormat
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomFormatSpecificationSchema'
      summary: Get api customformat schema
      x-summary-source: derived
      operationId: getApiV3CustomformatSchema
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/customformat:
    get:
      tags:
      - CustomFormat
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomFormatResource'
      summary: Get api customformat
      x-summary-source: derived
      operationId: getApiV5Customformat
      x-operation-id-source: derived
    post:
      tags:
      - CustomFormat
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFormatResource'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFormatResource'
        '404':
          description: Not Found
      summary: Create api customformat
      x-summary-source: derived
      operationId: postApiV5Customformat
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/customformat/{id}:
    put:
      tags:
      - CustomFormat
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFormatResource'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFormatResource'
        '404':
          description: Not Found
      summary: Replace api customformat by id
      x-summary-source: derived
      operationId: putApiV5CustomformatById
      x-operation-id-source: derived
    delete:
      tags:
      - CustomFormat
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: No Content
      summary: Delete api customformat by id
      x-summary-source: derived
      operationId: deleteApiV5CustomformatById
      x-operation-id-source: derived
    get:
      tags:
      - CustomFormat
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFormatResource'
        '404':
          description: Not Found
      summary: Get api customformat by id
      x-summary-source: derived
      operationId: getApiV5CustomformatById
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/customformat/bulk:
    put:
      tags:
      - CustomFormat
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFormatBulkResource'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomFormatResource'
      summary: Replace api customformat bulk
      x-summary-source: derived
      operationId: putApiV5CustomformatBulk
      x-operation-id-source: derived
    delete:
      tags:
      - CustomFormat
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFormatBulkResource'
      responses:
        '204':
          description: No Content
      summary: Delete api customformat bulk
      x-summary-source: derived
      operationId: deleteApiV5CustomformatBulk
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/customformat/schema:
    get:
      tags:
      - CustomFormat
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomFormatSpecificationSchema_2'
      summary: Get api customformat schema
      x-summary-source: derived
      operationId: getApiV5CustomformatSchema
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
components:
  schemas:
    PrivacyLevel:
      enum:
      - normal
      - password
      - apiKey
      - userName
      type: string
    CustomFormatBulkResource:
      type: object
      properties:
        ids:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        includeCustomFormatWhenRenaming:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    SelectOption:
      type: object
      properties:
        value:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        order:
          type: integer
          format: int32
        hint:
          type:
          - string
          - 'null'
      additionalProperties: false
    CustomFormatSpecificationSchema:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        implementation:
          type:
          - string
          - 'null'
        implementationName:
          type:
          - string
          - 'null'
        infoLink:
          type:
          - string
          - 'null'
        negate:
          type: boolean
        required:
          type: boolean
        fields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Field'
        presets:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomFormatSpecificationSchema'
      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
    CustomFormatResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        includeCustomFormatWhenRenaming:
          type:
          - boolean
          - 'null'
        specifications:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomFormatSpecificationSchema'
      additionalProperties: false
    CustomFormatSpecificationSchema_2:
      required:
      - fields
      - implementation
      - implementationName
      - infoLink
      - name
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        implementation:
          type:
          - string
          - 'null'
        implementationName:
          type:
          - string
          - 'null'
        infoLink:
          type:
          - string
          - 'null'
        negate:
          type: boolean
        required:
          type: boolean
        fields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Field'
        presets:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CustomFormatSpecificationSchema_2'
      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