Skip to main content
PATCH
/
api
/
v1
/
settings
Update server settings
curl --request PATCH \
  --url https://demo.komga.org/api/v1/settings \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deleteEmptyCollections": true,
  "deleteEmptyReadLists": true,
  "kepubifyPath": "<string>",
  "koboPort": 123,
  "koboProxy": true,
  "rememberMeDurationDays": 123,
  "renewRememberMeKey": true,
  "serverContextPath": "<string>",
  "serverPort": 123,
  "taskPoolSize": 123,
  "thumbnailSize": "DEFAULT"
}
'
{
  "violations": [
    {
      "fieldName": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

​
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

Fields to update. You can omit fields you don't want to update.

​
deleteEmptyCollections
boolean
​
deleteEmptyReadLists
boolean
​
kepubifyPath
string
deprecated

Will be removed in a future version

​
koboPort
integer<int32>
Required range: x <= 65535
​
koboProxy
boolean
​
rememberMeDurationDays
integer<int64>
​
renewRememberMeKey
boolean
​
serverContextPath
string
Pattern: ^/[\w-/]*[a-zA-Z0-9]$
​
serverPort
integer<int32>
Required range: x <= 65535
​
taskPoolSize
integer<int32>
​
thumbnailSize
enum<string>
Available options:
DEFAULT,
MEDIUM,
LARGE,
XLARGE

Response

No Content