---
title: "PATCH /api/user-settings"
method: PATCH
path: "/api/user-settings"
tags: ["App"]
---

# PATCH /api/user-settings

`PATCH /api/user-settings`

## Request body

- UserSettingsBody
  - `advancedSettings` boolean
  - `allowAutoThemes` boolean
  - `allowErrorMonitoring` boolean
  - `appDataPath` string
  - `appsRepoUrl` string, uri
  - `demoMode` boolean
  - `dnsIp` string, ipv4
  - `domain` string
  - `eventsTimeout` union
    - integer
    - string
  - `experimental_insecureCookie` boolean
  - `forwardAuthUrl` string, uri
  - `guestDashboard` boolean
  - `internalIp` string, ipv4
  - `listenIp` string, ipv4
  - `localDomain` string
  - `logLevel` 'debug' | 'error' | 'info' | 'warn'
  - `maxBackups` union
    - integer
    - string
  - `persistTraefikConfig` boolean
  - `port` union
    - integer
    - string
  - `postgresPort` union
    - integer
    - string
  - `sslPort` union
    - integer
    - string
  - `themeBase` string
  - `themeColor` string
  - `timeZone` string

## Response `200`

## Changes

- **2025-10-14** `7b4084eaeb8d` — 1 info
  - added the new optional request property `maxBackups`
- **2025-09-20** `b18f9d8a574e` — 1 info
  - request property `postgresPort` list-of-types was widened by adding types `string` to media type `application/json`
- **2025-09-19** `04aac8a043a6` — 3 breaking, 5 warning, 1 info
  - request property `port` list-of-types was narrowed by removing types `number` from media type `application/json`
  - request property `sslPort` list-of-types was narrowed by removing types `number` from media type `application/json`
  - the `postgresPort` request property type changed from `number` to `integer`
  - the `postgresPort` request property's max was set to `65535.00`
  - …5 more
- **2025-09-07** `8894b9440760` — 6 breaking, 1 warning
  - added the pattern `^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$` to the request property `dnsIp`
  - added the pattern `^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$` to the request property `internalIp`
  - added the pattern `^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$` to the request property `listenIp`
  - the `dnsIp` request property format changed from no format to `ipv4`
  - …3 more
- …earlier changes not shown

[Full history](https://skmtc.dev/runtipi/apis/runtipi-api/changes/api/user-settings/patch.md)

---

[API](https://skmtc.dev/runtipi/apis/runtipi-api.md) · [All operations](https://skmtc.dev/runtipi/apis/runtipi-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runtipi/runtipi-api/revisions/4cecb3c8a108/schema)