Get application settings
GET
/api/v1/settings
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");curl_easy_setopt(hnd, CURLOPT_URL, "http://127.0.0.1:58259/api/v1/settings");
CURLcode ret = curl_easy_perform(hnd);using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("http://127.0.0.1:58259/api/v1/settings"),};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}package main
import ( "fmt" "net/http" "io")
func main() {
url := "http://127.0.0.1:58259/api/v1/settings"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("http://127.0.0.1:58259/api/v1/settings")) .method("GET", HttpRequest.BodyPublishers.noBody()) .build();HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());System.out.println(response.body());OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder() .url("http://127.0.0.1:58259/api/v1/settings") .get() .build();
Response response = client.newCall(request).execute();import axios from 'axios';
const options = {method: 'GET', url: 'http://127.0.0.1:58259/api/v1/settings'};
try { const { data } = await axios.request(options); console.log(data);} catch (error) { console.error(error);}const url = 'http://127.0.0.1:58259/api/v1/settings';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}val client = OkHttpClient()
val request = Request.Builder() .url("http://127.0.0.1:58259/api/v1/settings") .get() .build()
val response = client.newCall(request).execute()use reqwest;
#[tokio::main]pub async fn main() { let url = "http://127.0.0.1:58259/api/v1/settings";
let client = reqwest::Client::new(); let response = client.get(url) .send() .await;
let results = response.unwrap() .json::<serde_json::Value>() .await .unwrap();
dbg!(results);}curl --request GET \ --url http://127.0.0.1:58259/api/v1/settingswget --quiet \ --method GET \ --output-document \ - http://127.0.0.1:58259/api/v1/settingsRetrieve all application settings.
Responses
Section titled “ Responses ”Application settings returned successfully
Media type */*
object
defaultMetadataRefreshOptions
object
libraryId
integer format: int64
refreshCovers
boolean
mergeCategories
boolean
reviewBeforeApply
boolean
replaceMode
string
fieldOptions
required
object
title
object
p1
string
p2
string
p3
string
p4
string
subtitle
object
p1
string
p2
string
p3
string
p4
string
description
object
p1
string
p2
string
p3
string
p4
string
authors
object
p1
string
p2
string
p3
string
p4
string
publisher
object
p1
string
p2
string
p3
string
p4
string
publishedDate
object
p1
string
p2
string
p3
string
p4
string
seriesName
object
p1
string
p2
string
p3
string
p4
string
seriesNumber
object
p1
string
p2
string
p3
string
p4
string
seriesTotal
object
p1
string
p2
string
p3
string
p4
string
isbn13
object
p1
string
p2
string
p3
string
p4
string
isbn10
object
p1
string
p2
string
p3
string
p4
string
language
object
p1
string
p2
string
p3
string
p4
string
categories
object
p1
string
p2
string
p3
string
p4
string
cover
object
p1
string
p2
string
p3
string
p4
string
pageCount
object
p1
string
p2
string
p3
string
p4
string
asin
object
p1
string
p2
string
p3
string
p4
string
goodreadsId
object
p1
string
p2
string
p3
string
p4
string
comicvineId
object
p1
string
p2
string
p3
string
p4
string
hardcoverId
object
p1
string
p2
string
p3
string
p4
string
hardcoverBookId
object
p1
string
p2
string
p3
string
p4
string
googleId
object
p1
string
p2
string
p3
string
p4
string
lubimyczytacId
object
p1
string
p2
string
p3
string
p4
string
amazonRating
object
p1
string
p2
string
p3
string
p4
string
amazonReviewCount
object
p1
string
p2
string
p3
string
p4
string
goodreadsRating
object
p1
string
p2
string
p3
string
p4
string
goodreadsReviewCount
object
p1
string
p2
string
p3
string
p4
string
hardcoverRating
object
p1
string
p2
string
p3
string
p4
string
hardcoverReviewCount
object
p1
string
p2
string
p3
string
p4
string
lubimyczytacRating
object
p1
string
p2
string
p3
string
p4
string
ranobedbId
object
p1
string
p2
string
p3
string
p4
string
ranobedbRating
object
p1
string
p2
string
p3
string
p4
string
audibleId
object
p1
string
p2
string
p3
string
p4
string
audibleRating
object
p1
string
p2
string
p3
string
p4
string
audibleReviewCount
object
p1
string
p2
string
p3
string
p4
string
moods
object
p1
string
p2
string
p3
string
p4
string
tags
object
p1
string
p2
string
p3
string
p4
string
enabledFields
required
object
title
boolean
subtitle
boolean
description
boolean
authors
boolean
publisher
boolean
publishedDate
boolean
seriesName
boolean
seriesNumber
boolean
seriesTotal
boolean
isbn13
boolean
isbn10
boolean
language
boolean
categories
boolean
cover
boolean
pageCount
boolean
asin
boolean
goodreadsId
boolean
comicvineId
boolean
hardcoverId
boolean
hardcoverBookId
boolean
googleId
boolean
lubimyczytacId
boolean
amazonRating
boolean
amazonReviewCount
boolean
goodreadsRating
boolean
goodreadsReviewCount
boolean
hardcoverRating
boolean
hardcoverReviewCount
boolean
lubimyczytacRating
boolean
ranobedbId
boolean
ranobedbRating
boolean
audibleId
boolean
audibleRating
boolean
audibleReviewCount
boolean
moods
boolean
tags
boolean
libraryMetadataRefreshOptions
Array<object>
object
libraryId
integer format: int64
refreshCovers
boolean
mergeCategories
boolean
reviewBeforeApply
boolean
replaceMode
string
fieldOptions
required
object
title
object
p1
string
p2
string
p3
string
p4
string
subtitle
object
p1
string
p2
string
p3
string
p4
string
description
object
p1
string
p2
string
p3
string
p4
string
authors
object
p1
string
p2
string
p3
string
p4
string
publisher
object
p1
string
p2
string
p3
string
p4
string
publishedDate
object
p1
string
p2
string
p3
string
p4
string
seriesName
object
p1
string
p2
string
p3
string
p4
string
seriesNumber
object
p1
string
p2
string
p3
string
p4
string
seriesTotal
object
p1
string
p2
string
p3
string
p4
string
isbn13
object
p1
string
p2
string
p3
string
p4
string
isbn10
object
p1
string
p2
string
p3
string
p4
string
language
object
p1
string
p2
string
p3
string
p4
string
categories
object
p1
string
p2
string
p3
string
p4
string
cover
object
p1
string
p2
string
p3
string
p4
string
pageCount
object
p1
string
p2
string
p3
string
p4
string
asin
object
p1
string
p2
string
p3
string
p4
string
goodreadsId
object
p1
string
p2
string
p3
string
p4
string
comicvineId
object
p1
string
p2
string
p3
string
p4
string
hardcoverId
object
p1
string
p2
string
p3
string
p4
string
hardcoverBookId
object
p1
string
p2
string
p3
string
p4
string
googleId
object
p1
string
p2
string
p3
string
p4
string
lubimyczytacId
object
p1
string
p2
string
p3
string
p4
string
amazonRating
object
p1
string
p2
string
p3
string
p4
string
amazonReviewCount
object
p1
string
p2
string
p3
string
p4
string
goodreadsRating
object
p1
string
p2
string
p3
string
p4
string
goodreadsReviewCount
object
p1
string
p2
string
p3
string
p4
string
hardcoverRating
object
p1
string
p2
string
p3
string
p4
string
hardcoverReviewCount
object
p1
string
p2
string
p3
string
p4
string
lubimyczytacRating
object
p1
string
p2
string
p3
string
p4
string
ranobedbId
object
p1
string
p2
string
p3
string
p4
string
ranobedbRating
object
p1
string
p2
string
p3
string
p4
string
audibleId
object
p1
string
p2
string
p3
string
p4
string
audibleRating
object
p1
string
p2
string
p3
string
p4
string
audibleReviewCount
object
p1
string
p2
string
p3
string
p4
string
moods
object
p1
string
p2
string
p3
string
p4
string
tags
object
p1
string
p2
string
p3
string
p4
string
enabledFields
required
object
title
boolean
subtitle
boolean
description
boolean
authors
boolean
publisher
boolean
publishedDate
boolean
seriesName
boolean
seriesNumber
boolean
seriesTotal
boolean
isbn13
boolean
isbn10
boolean
language
boolean
categories
boolean
cover
boolean
pageCount
boolean
asin
boolean
goodreadsId
boolean
comicvineId
boolean
hardcoverId
boolean
hardcoverBookId
boolean
googleId
boolean
lubimyczytacId
boolean
amazonRating
boolean
amazonReviewCount
boolean
goodreadsRating
boolean
goodreadsReviewCount
boolean
hardcoverRating
boolean
hardcoverReviewCount
boolean
lubimyczytacRating
boolean
ranobedbId
boolean
ranobedbRating
boolean
audibleId
boolean
audibleRating
boolean
audibleReviewCount
boolean
moods
boolean
tags
boolean
autoBookSearch
boolean
similarBookRecommendation
boolean
opdsServerEnabled
boolean
komgaApiEnabled
boolean
komgaGroupUnknown
boolean
uploadPattern
string
pdfCacheSizeInMb
integer format: int32
maxFileUploadSizeInMb
integer format: int32
remoteAuthEnabled
boolean
metadataDownloadOnBookdrop
boolean
oidcEnabled
boolean
oidcProviderDetails
object
providerName
string
clientId
string
clientSecret
string
issuerUri
string
scopes
string
claimMapping
object
username
string
name
string
email
string
groups
string
oidcRedirectUris
Array<string>
oidcAutoProvisionDetails
object
enableAutoProvisioning
boolean
allowLocalAccountLinking
boolean
defaultPermissions
Array<string>
defaultLibraryIds
Array<integer>
metadataProviderSettings
object
amazon
object
enabled
boolean
cookie
string
domain
string
google
object
enabled
boolean
language
string
apiKey
string
goodReads
object
enabled
boolean
hardcover
object
enabled
boolean
apiKey
string
comicvine
object
enabled
boolean
apiKey
string
ranobedb
object
enabled
boolean
douban
object
enabled
boolean
audible
object
enabled
boolean
domain
string
lubimyczytac
object
enabled
boolean
metadataMatchWeights
object
title
integer format: int32
subtitle
integer format: int32
description
integer format: int32
authors
integer format: int32
publisher
integer format: int32
publishedDate
integer format: int32
seriesName
integer format: int32
seriesNumber
integer format: int32
seriesTotal
integer format: int32
isbn13
integer format: int32
isbn10
integer format: int32
language
integer format: int32
pageCount
integer format: int32
categories
integer format: int32
amazonRating
integer format: int32
amazonReviewCount
integer format: int32
goodreadsRating
integer format: int32
goodreadsReviewCount
integer format: int32
hardcoverRating
integer format: int32
hardcoverReviewCount
integer format: int32
doubanRating
integer format: int32
doubanReviewCount
integer format: int32
ranobedbRating
integer format: int32
lubimyczytacRating
integer format: int32
audibleRating
integer format: int32
audibleReviewCount
integer format: int32
coverImage
integer format: int32
metadataPersistenceSettings
object
saveToOriginalFile
object
epub
object
enabled
boolean
maxFileSizeInMb
integer format: int32
pdf
object
enabled
boolean
maxFileSizeInMb
integer format: int32
cbx
object
enabled
boolean
maxFileSizeInMb
integer format: int32
audiobook
object
enabled
boolean
maxFileSizeInMb
integer format: int32
anyFormatEnabled
boolean
convertCbrCb7ToCbz
boolean
moveFilesToLibraryPattern
boolean
sidecarSettings
object
enabled
boolean
writeOnUpdate
boolean
writeOnScan
boolean
includeCoverFile
boolean
metadataPublicReviewsSettings
object
downloadEnabled
boolean
autoDownloadEnabled
boolean
providers
Array<object>
object
provider
string
enabled
boolean
maxReviews
integer format: int32
koboSettings
object
convertToKepub
boolean
conversionLimitInMb
integer format: int32
convertCbxToEpub
boolean
conversionLimitInMbForCbx
integer format: int32
forceEnableHyphenation
boolean
conversionImageCompressionPercentage
integer format: int32
forwardToKoboStore
boolean
coverCroppingSettings
object
verticalCroppingEnabled
boolean
horizontalCroppingEnabled
boolean
aspectRatioThreshold
number format: double
smartCroppingEnabled
boolean
metadataProviderSpecificFields
object
asin
boolean
amazonRating
boolean
amazonReviewCount
boolean
googleId
boolean
goodreadsId
boolean
goodreadsRating
boolean
goodreadsReviewCount
boolean
hardcoverId
boolean
hardcoverBookId
boolean
hardcoverRating
boolean
hardcoverReviewCount
boolean
comicvineId
boolean
lubimyczytacId
boolean
lubimyczytacRating
boolean
ranobedbId
boolean
ranobedbRating
boolean
audibleId
boolean
audibleRating
boolean
audibleReviewCount
boolean
oidcSessionDurationHours
integer format: int32
oidcGroupSyncMode
string
oidcForceOnlyMode
boolean
diskType
string