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-filesystem-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 File System API
  license:
    name: GPL-3.0
    url: https://github.com/Sonarr/Sonarr/blob/develop/LICENSE
  version: '1.0'
  description: 'Operations tagged FileSystem 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: Filesystem
paths:
  /api/v3/filesystem:
    get:
      tags:
      - Filesystem
      parameters:
      - name: path
        in: query
        schema:
          type: string
      - name: includeFiles
        in: query
        schema:
          type: boolean
          default: false
      - name: allowFoldersWithoutTrailingSlashes
        in: query
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
      summary: Get api filesystem
      x-summary-source: derived
      operationId: getApiV3Filesystem
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v3/filesystem/type:
    get:
      tags:
      - Filesystem
      parameters:
      - name: path
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      summary: Get api filesystem type
      x-summary-source: derived
      operationId: getApiV3FilesystemType
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v3/filesystem/mediafiles:
    get:
      tags:
      - Filesystem
      parameters:
      - name: path
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
      summary: Get api filesystem mediafiles
      x-summary-source: derived
      operationId: getApiV3FilesystemMediafiles
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/filesystem:
    get:
      tags:
      - Filesystem
      parameters:
      - name: path
        in: query
        schema:
          type: string
      - name: includeFiles
        in: query
        schema:
          type: boolean
          default: false
      - name: allowFoldersWithoutTrailingSlashes
        in: query
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemResult'
      summary: Get api filesystem
      x-summary-source: derived
      operationId: getApiV5Filesystem
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/filesystem/type:
    get:
      tags:
      - Filesystem
      parameters:
      - name: path
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystemTypeResource'
      summary: Get api filesystem type
      x-summary-source: derived
      operationId: getApiV5FilesystemType
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
  /api/v5/filesystem/mediafiles:
    get:
      tags:
      - Filesystem
      parameters:
      - name: path
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FileSystemMediaFileResource'
      summary: Get api filesystem mediafiles
      x-summary-source: derived
      operationId: getApiV5FilesystemMediafiles
      x-operation-id-source: derived
    servers:
    - url: '{protocol}://{hostpath}'
      variables:
        protocol:
          default: http
          enum:
          - http
          - https
        hostpath:
          default: localhost:8989
components:
  schemas:
    FileSystemEntityType:
      enum:
      - parent
      - drive
      - folder
      - file
      type: string
    FileSystemMediaFileResource:
      type: object
      properties:
        path:
          type:
          - string
          - 'null'
        relativePath:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
      additionalProperties: false
    FileSystemTypeResource:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/FileSystemEntityType'
      additionalProperties: false
    FileSystemModel:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/FileSystemEntityType'
        name:
          type:
          - string
          - 'null'
        path:
          type:
          - string
          - 'null'
        extension:
          type:
          - string
          - 'null'
        size:
          type: integer
          format: int64
        lastModified:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    FileSystemResult:
      type: object
      properties:
        parent:
          type:
          - string
          - 'null'
        directories:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FileSystemModel'
        files:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/FileSystemModel'
      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