Sign in

v52

latestOpenAPI 3.0.4GPL-3.0raw.githubusercontent.com2026-08-03509370876.8 KB
Settings

Returns the server settings

get/api/Settings

Response

OK

cacheDirectorystring nullable
taskScanstring nullable
taskBackupstring nullable
taskCleanupstring nullable
taskCblSyncstring nullable
loggingLevelstring nullable
portinteger
ipAddressesstring nullable
allowStatCollectionboolean
enableOpdsboolean
baseUrlstring nullable
bookmarksDirectorystring nullable
installVersionstring nullable
installIdstring nullable
encodeMediaAs0 | 1 | 2

Members:

  • 0 — PNG
  • 1 — WebP (WEBP)
  • 2 — AVIF
totalBackupsinteger
enableFolderWatchingboolean
totalLogsinteger
hostNamestring nullable
cacheSizeinteger
onDeckProgressDaysinteger
onDeckUpdateDaysinteger
coverImageSize1 | 2 | 3 | 4

Members:

  • 1 — Default
  • 2 — Medium
  • 3 — Large
  • 4 — XLarge
pdfRenderResolution1 | 2 | 3

Members:

  • 1 — Default
  • 2 — High
  • 3 — Ultra
firstInstallDatestring date-time nullable
firstInstallVersionstring nullable
statsApiHitsinteger