Retrieve server settings

Required role: ADMIN

GET /api/v1/settings

Retrieve server settings

cURL

curl --request GET \
  --url https://demo.komga.org/api/v1/settings \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "deleteEmptyCollections": true,
  "deleteEmptyReadLists": true,
  "kepubifyPath": {
    "configurationSource": "<string>",
    "databaseSource": "<string>",
    "effectiveValue": "<string>"
  },
  "koboProxy": true,
  "rememberMeDurationDays": 123,
  "serverContextPath": {
    "configurationSource": "<string>",
    "databaseSource": "<string>",
    "effectiveValue": "<string>"
  },
  "serverPort": {
    "configurationSource": 123,
    "databaseSource": 123,
    "effectiveValue": 123
  },
  "taskPoolSize": 123,
  "thumbnailSize": "DEFAULT",
  "koboPort": 123
}

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.

Response

200

application/json

OK

deleteEmptyCollections · boolean · required

deleteEmptyReadLists · boolean · required

kepubifyPath · object · required

Show child attributes

koboProxy · boolean · required

rememberMeDurationDays · integer<int64> · required

serverContextPath · object · required

Show child attributes

serverPort · object · required

Show child attributes

taskPoolSize · integer<int32> · required

thumbnailSize · enum<string> · required

Available options: DEFAULT, MEDIUM, LARGE, XLARGE

koboPort · integer<int32>