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-namingconfig-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 Naming Config API
  description: Sonarr API docs - The v3 API docs apply to both v3 and v4 versions of Sonarr. Some functionality may only be available in v4 of the Sonarr application.
  license:
    name: GPL-3.0
    url: https://github.com/Sonarr/Sonarr/blob/develop/LICENSE
  version: 3.0.0
servers:
- url: '{protocol}://{hostpath}'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    hostpath:
      default: localhost:8989
security:
- X-Api-Key: []
- apikey: []
tags:
- name: NamingConfig
paths:
  /api/v3/config/naming:
    get:
      tags:
      - NamingConfig
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/NamingConfigResource'
            application/json:
              schema:
                $ref: '#/components/schemas/NamingConfigResource'
            text/json:
              schema:
                $ref: '#/components/schemas/NamingConfigResource'
      summary: Get api config naming
      x-summary-source: derived
      operationId: getApiV3ConfigNaming
      x-operation-id-source: derived
  /api/v3/config/naming/{id}:
    put:
      tags:
      - NamingConfig
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NamingConfigResource'
          text/json:
            schema:
              $ref: '#/components/schemas/NamingConfigResource'
          application/*+json:
            schema:
              $ref: '#/components/schemas/NamingConfigResource'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/NamingConfigResource'
            application/json:
              schema:
                $ref: '#/components/schemas/NamingConfigResource'
            text/json:
              schema:
                $ref: '#/components/schemas/NamingConfigResource'
      summary: Replace api config naming by id
      x-summary-source: derived
      operationId: putApiV3ConfigNamingById
      x-operation-id-source: derived
    get:
      tags:
      - NamingConfig
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NamingConfigResource'
        '404':
          description: Not Found
      summary: Get api config naming by id
      x-summary-source: derived
      operationId: getApiV3ConfigNamingById
      x-operation-id-source: derived
  /api/v3/config/naming/examples:
    get:
      tags:
      - NamingConfig
      parameters:
      - name: renameEpisodes
        in: query
        schema:
          type: boolean
      - name: replaceIllegalCharacters
        in: query
        schema:
          type: boolean
      - name: colonReplacementFormat
        in: query
        schema:
          type: integer
          format: int32
      - name: customColonReplacementFormat
        in: query
        schema:
          type: string
      - name: multiEpisodeStyle
        in: query
        schema:
          type: integer
          format: int32
      - name: standardEpisodeFormat
        in: query
        schema:
          type: string
      - name: dailyEpisodeFormat
        in: query
        schema:
          type: string
      - name: animeEpisodeFormat
        in: query
        schema:
          type: string
      - name: seriesFolderFormat
        in: query
        schema:
          type: string
      - name: seasonFolderFormat
        in: query
        schema:
          type: string
      - name: specialsFolderFormat
        in: query
        schema:
          type: string
      - name: id
        in: query
        schema:
          type: integer
          format: int32
      - name: resourceName
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      summary: Get api config naming examples
      x-summary-source: derived
      operationId: getApiV3ConfigNamingExamples
      x-operation-id-source: derived
components:
  schemas:
    NamingConfigResource:
      type: object
      properties:
        id:
          type: integer
          format: int32
        renameEpisodes:
          type: boolean
        replaceIllegalCharacters:
          type: boolean
        colonReplacementFormat:
          type: integer
          format: int32
        customColonReplacementFormat:
          type:
          - string
          - 'null'
        multiEpisodeStyle:
          type: integer
          format: int32
        standardEpisodeFormat:
          type:
          - string
          - 'null'
        dailyEpisodeFormat:
          type:
          - string
          - 'null'
        animeEpisodeFormat:
          type:
          - string
          - 'null'
        seriesFolderFormat:
          type:
          - string
          - 'null'
        seasonFolderFormat:
          type:
          - string
          - 'null'
        specialsFolderFormat:
          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