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
}
'import requests
url = "https://demo.komga.org/api/v1/settings"
payload = {
"deleteEmptyCollections": True,
"deleteEmptyReadLists": True,
"kepubifyPath": "<string>",
"koboPort": 123,
"koboProxy": True,
"rememberMeDurationDays": 123,
"renewRememberMeKey": True,
"serverContextPath": "<string>",
"serverPort": 123,
"taskPoolSize": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
deleteEmptyCollections: true,
deleteEmptyReadLists: true,
kepubifyPath: '<string>',
koboPort: 123,
koboProxy: true,
rememberMeDurationDays: 123,
renewRememberMeKey: true,
serverContextPath: '<string>',
serverPort: 123,
taskPoolSize: 123
})
};
fetch('https://demo.komga.org/api/v1/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://demo.komga.org/api/v1/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'deleteEmptyCollections' => true,
'deleteEmptyReadLists' => true,
'kepubifyPath' => '<string>',
'koboPort' => 123,
'koboProxy' => true,
'rememberMeDurationDays' => 123,
'renewRememberMeKey' => true,
'serverContextPath' => '<string>',
'serverPort' => 123,
'taskPoolSize' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://demo.komga.org/api/v1/settings"
payload := strings.NewReader("{\n \"deleteEmptyCollections\": true,\n \"deleteEmptyReadLists\": true,\n \"kepubifyPath\": \"<string>\",\n \"koboPort\": 123,\n \"koboProxy\": true,\n \"rememberMeDurationDays\": 123,\n \"renewRememberMeKey\": true,\n \"serverContextPath\": \"<string>\",\n \"serverPort\": 123,\n \"taskPoolSize\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://demo.komga.org/api/v1/settings")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"deleteEmptyCollections\": true,\n \"deleteEmptyReadLists\": true,\n \"kepubifyPath\": \"<string>\",\n \"koboPort\": 123,\n \"koboProxy\": true,\n \"rememberMeDurationDays\": 123,\n \"renewRememberMeKey\": true,\n \"serverContextPath\": \"<string>\",\n \"serverPort\": 123,\n \"taskPoolSize\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://demo.komga.org/api/v1/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"deleteEmptyCollections\": true,\n \"deleteEmptyReadLists\": true,\n \"kepubifyPath\": \"<string>\",\n \"koboPort\": 123,\n \"koboProxy\": true,\n \"rememberMeDurationDays\": 123,\n \"renewRememberMeKey\": true,\n \"serverContextPath\": \"<string>\",\n \"serverPort\": 123,\n \"taskPoolSize\": 123\n}"
response = http.request(request)
puts response.read_body{
"violations": [
{
"fieldName": "<string>",
"message": "<string>"
}
]
}Server settings
Update server settings
You can omit fields you don’t want to update
Required role: ADMIN
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
}
'import requests
url = "https://demo.komga.org/api/v1/settings"
payload = {
"deleteEmptyCollections": True,
"deleteEmptyReadLists": True,
"kepubifyPath": "<string>",
"koboPort": 123,
"koboProxy": True,
"rememberMeDurationDays": 123,
"renewRememberMeKey": True,
"serverContextPath": "<string>",
"serverPort": 123,
"taskPoolSize": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
deleteEmptyCollections: true,
deleteEmptyReadLists: true,
kepubifyPath: '<string>',
koboPort: 123,
koboProxy: true,
rememberMeDurationDays: 123,
renewRememberMeKey: true,
serverContextPath: '<string>',
serverPort: 123,
taskPoolSize: 123
})
};
fetch('https://demo.komga.org/api/v1/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://demo.komga.org/api/v1/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'deleteEmptyCollections' => true,
'deleteEmptyReadLists' => true,
'kepubifyPath' => '<string>',
'koboPort' => 123,
'koboProxy' => true,
'rememberMeDurationDays' => 123,
'renewRememberMeKey' => true,
'serverContextPath' => '<string>',
'serverPort' => 123,
'taskPoolSize' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://demo.komga.org/api/v1/settings"
payload := strings.NewReader("{\n \"deleteEmptyCollections\": true,\n \"deleteEmptyReadLists\": true,\n \"kepubifyPath\": \"<string>\",\n \"koboPort\": 123,\n \"koboProxy\": true,\n \"rememberMeDurationDays\": 123,\n \"renewRememberMeKey\": true,\n \"serverContextPath\": \"<string>\",\n \"serverPort\": 123,\n \"taskPoolSize\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://demo.komga.org/api/v1/settings")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"deleteEmptyCollections\": true,\n \"deleteEmptyReadLists\": true,\n \"kepubifyPath\": \"<string>\",\n \"koboPort\": 123,\n \"koboProxy\": true,\n \"rememberMeDurationDays\": 123,\n \"renewRememberMeKey\": true,\n \"serverContextPath\": \"<string>\",\n \"serverPort\": 123,\n \"taskPoolSize\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://demo.komga.org/api/v1/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"deleteEmptyCollections\": true,\n \"deleteEmptyReadLists\": true,\n \"kepubifyPath\": \"<string>\",\n \"koboPort\": 123,\n \"koboProxy\": true,\n \"rememberMeDurationDays\": 123,\n \"renewRememberMeKey\": true,\n \"serverContextPath\": \"<string>\",\n \"serverPort\": 123,\n \"taskPoolSize\": 123\n}"
response = http.request(request)
puts response.read_body{
"violations": [
{
"fieldName": "<string>",
"message": "<string>"
}
]
}Authorizations
basicAuthapiKey
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.
Will be removed in a future version
Required range:
x <= 65535Pattern:
^/[\w-/]*[a-zA-Z0-9]$Required range:
x <= 65535Available options:
DEFAULT, MEDIUM, LARGE, XLARGE Response
No Content