Directory listing

List folders and files from the host server’s file system. If no request body is passed then the root directories are returned.

Required role: ADMIN

POST /api/v1/filesystem

Directory listing

cURL

curl --request POST \
  --url https://demo.komga.org/api/v1/filesystem \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>",
  "showFiles": true
}
'

200

{
  "directories": [
    {
      "name": "<string>",
      "path": "<string>",
      "type": "<string>"
    }
  ],
  "files": [
    {
      "name": "<string>",
      "path": "<string>",
      "type": "<string>"
    }
  ],
  "parent": "<string>"
}

Authorizations

basicAuthapiKey

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

path · string · required

showFiles · boolean · required

Response

200

application/json

OK

directories · object[] · required

Show child attributes

files · object[] · required

Show child attributes

parent · string