---
title: "Returns the server settings"
method: GET
path: "/api/Settings"
tags: ["Settings"]
---

# Returns the server settings

`GET /api/Settings`

## Response `200`

OK

- ServerSettingDto
  - `cacheDirectory` string, nullable
  - `taskScan` string, nullable
  - `taskBackup` string, nullable
  - `taskCleanup` string, nullable
  - `taskCblSync` string, nullable
  - `loggingLevel` string, nullable
  - `port` integer
  - `ipAddresses` string, nullable
  - `allowStatCollection` boolean
  - `enableOpds` boolean
  - `baseUrl` string, nullable
  - `bookmarksDirectory` string, nullable
  - `installVersion` string, nullable
  - `installId` string, nullable
  - `encodeMediaAs` 0 | 1 | 2 — Members: - `0` — PNG - `1` — WebP (WEBP) - `2` — AVIF
  - `totalBackups` integer
  - `enableFolderWatching` boolean
  - `totalLogs` integer
  - `hostName` string, nullable
  - `cacheSize` integer
  - `onDeckProgressDays` integer
  - `onDeckUpdateDays` integer
  - `coverImageSize` 1 | 2 | 3 | 4 — Members: - `1` — Default - `2` — Medium - `3` — Large - `4` — XLarge
  - `pdfRenderResolution` 1 | 2 | 3 — Members: - `1` — Default - `2` — High - `3` — Ultra
  - `smtpConfig` SmtpConfigDto
    - `senderAddress` string, nullable
    - `senderDisplayName` string, nullable
    - `userName` string, nullable
    - `password` string, nullable
    - `host` string, nullable
    - `port` integer
    - `enableSsl` boolean
    - `sizeLimit` integer
    - `customizedTemplates` boolean
  - `oidcConfig` OidcConfigDto
    - `autoLogin` boolean
    - `disablePasswordAuthentication` boolean
    - `providerName` string, nullable
    - `authority` string, nullable
    - `clientId` string, nullable
    - `secret` string, nullable
    - `provisionAccounts` boolean
    - `requireVerifiedEmail` boolean
    - `syncUserSettings` boolean
    - `rolesPrefix` string, nullable
    - `rolesClaim` string, nullable
    - `customScopes` string[], nullable
    - `defaultRoles` string[], nullable
    - `defaultLibraries` integer[], nullable
    - `defaultAgeRestriction` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | -1 — Members: - `0` — Unknown - `1` — Rating Pending (RatingPending) - `2` — Early Childhood (EarlyChildhood) - `3` — Everyone - `4` — G - `5` — Everyone 10+ (Everyone10Plus) - `6` — PG - `7` — Kids to Adults (KidsToAdults) - `8` — Teen - `9` — MA15+ (Mature15Plus) - `10` — Mature 17+ (Mature17Plus) - `11` — M (Mature) - `12` — R18+ (R18Plus) - `13` — Adults Only 18+ (AdultsOnly) - `14` — X18+ (X18Plus) - `-1` — Not Applicable (NotApplicable)
    - `defaultIncludeUnknowns` boolean
    - `enabled` boolean
  - `firstInstallDate` string, date-time, nullable
  - `firstInstallVersion` string, nullable
  - `statsApiHits` integer

---

[API](https://skmtc.net/kareadita/apis/kavita.md) · [All operations](https://skmtc.net/kareadita/apis/kavita/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kareadita/kavita/versions/a092f0284f3e/schema)