KAkareadita
Settings

Update Server settings

Changed on
post/api/Settings

Request

  • Base URL
    http://localhost:5000
  • URL
    http://localhost:5000/api/Settings
  • Auth
    API key in header x-api-key

Request body

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

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

Changes

  • b7e0c1ec55a5Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

  • d871bfda2376Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)