---
title: "Update Cribl system settings"
method: PATCH
path: "/system/settings/conf"
tags: ["system"]
---

# Update Cribl system settings

`PATCH /system/settings/conf`

Update Cribl system settings.

## Request body

- SystemSettingsConf
  - `api` ApiTypeSystemSettingsConf, required
    - `baseUrl` string
    - `disableApiCache` boolean
    - `disabled` boolean, required
    - `headers` object
    - `host` string, required
    - `idleSessionTTL` number
    - `listenOnPort` boolean
    - `loginRateLimit` string
    - `port` number, required
    - `protocol` string
    - `scripts` boolean
    - `sensitiveFields` string[]
    - `ssl` SslTypeSystemSettingsConfApi
      - `caPath` string
      - `certPath` string, required
      - `disabled` boolean, required
      - `passphrase` string, required
      - `privKeyPath` string, required
    - `ssoRateLimit` string
    - `workerRemoteAccess` boolean
  - `backups` union, required
    - object
      - `backupPersistence` string, required
      - `backupsDirectory` string, required
    - object
  - `customLogo` CustomLogoTypeSystemSettingsConf
    - `enabled` boolean, required
    - `logoDescription` string
    - `logoImage` string
  - `pii` union, required
    - object
      - `enablePiiDetection` boolean, required
    - object
  - `proxy` ProxyTypeSystemSettingsConf, required
    - `useEnvVars` boolean, required
  - `rollback` union, required
    - object
      - `rollbackEnabled` boolean, required
      - `rollbackRetries` number
      - `rollbackTimeout` number
    - object
  - `shutdown` ShutdownTypeSystemSettingsConf, required
    - `drainTimeout` number, required
  - `sni` union, required
    - object
      - `disableSNIRouting` boolean, required
    - object
  - `sockets` SocketsTypeSystemSettingsConf
    - `directory` string
  - `support` SupportTypeSystemSettingsConf
    - `featureFlagOverrides` ItemsTypeSystemSettingsConfSupportFeatureFlagOverrides[]
      - `disabled` boolean, required
      - `flagId` string, required
  - `system` SystemTypeSystemSettingsConf, required
    - `intercom` boolean, required
    - `upgrade` unknown, required
  - `tls` union, required
    - object
      - `defaultCipherList` string, required
      - `defaultEcdhCurve` string, required
      - `maxVersion` string, required
      - `minVersion` string, required
      - `rejectUnauthorized` boolean, required
    - object
  - `upgradeGroupSettings` union, required
    - object
      - `isRolling` boolean
      - `quantity` number
      - `retryCount` number
      - `retryDelay` number
    - object
  - `upgradeSettings` UpgradeSettings, required
    - `automaticUpgradeCheckPeriod` string
    - `disableAutomaticUpgrade` boolean
    - `enableLegacyEdgeUpgrade` boolean
    - `packageUrls` UpgradePackageUrls[]
      - `packageHashUrl` string
      - `packageUrl` string, required
    - `upgradeSource` string
  - `workers` WorkersTypeSystemSettingsConf, required
    - `count` number, required
    - `enableHeapSnapshots` boolean
    - `loadThrottlePerc` number
    - `memory` number, required
    - `minimum` number, required
    - `startupMaxConns` number
    - `startupThrottleTimeout` number
    - `v8SingleThread` boolean

## Response `200`

a list of SystemSettingsConf objects

- CountedSystemSettingsConf
  - `count` integer — number of items present in the items array
  - `items` SystemSettingsConf[]
    - `api` ApiTypeSystemSettingsConf, required
      - `baseUrl` string
      - `disableApiCache` boolean
      - `disabled` boolean, required
      - `headers` object
      - `host` string, required
      - `idleSessionTTL` number
      - `listenOnPort` boolean
      - `loginRateLimit` string
      - `port` number, required
      - `protocol` string
      - `scripts` boolean
      - `sensitiveFields` string[]
      - `ssl` SslTypeSystemSettingsConfApi
        - `caPath` string
        - `certPath` string, required
        - `disabled` boolean, required
        - `passphrase` string, required
        - `privKeyPath` string, required
      - `ssoRateLimit` string
      - `workerRemoteAccess` boolean
    - `backups` union, required
      - object
        - `backupPersistence` string, required
        - `backupsDirectory` string, required
      - object
    - `customLogo` CustomLogoTypeSystemSettingsConf
      - `enabled` boolean, required
      - `logoDescription` string
      - `logoImage` string
    - `pii` union, required
      - object
        - `enablePiiDetection` boolean, required
      - object
    - `proxy` ProxyTypeSystemSettingsConf, required
      - `useEnvVars` boolean, required
    - `rollback` union, required
      - object
        - `rollbackEnabled` boolean, required
        - `rollbackRetries` number
        - `rollbackTimeout` number
      - object
    - `shutdown` ShutdownTypeSystemSettingsConf, required
      - `drainTimeout` number, required
    - `sni` union, required
      - object
        - `disableSNIRouting` boolean, required
      - object
    - `sockets` SocketsTypeSystemSettingsConf
      - `directory` string
    - `support` SupportTypeSystemSettingsConf
      - `featureFlagOverrides` ItemsTypeSystemSettingsConfSupportFeatureFlagOverrides[]
        - `disabled` boolean, required
        - `flagId` string, required
    - `system` SystemTypeSystemSettingsConf, required
      - `intercom` boolean, required
      - `upgrade` unknown, required
    - `tls` union, required
      - object
        - `defaultCipherList` string, required
        - `defaultEcdhCurve` string, required
        - `maxVersion` string, required
        - `minVersion` string, required
        - `rejectUnauthorized` boolean, required
      - object
    - `upgradeGroupSettings` union, required
      - object
        - `isRolling` boolean
        - `quantity` number
        - `retryCount` number
        - `retryDelay` number
      - object
    - `upgradeSettings` UpgradeSettings, required
      - `automaticUpgradeCheckPeriod` string
      - `disableAutomaticUpgrade` boolean
      - `enableLegacyEdgeUpgrade` boolean
      - `packageUrls` UpgradePackageUrls[]
        - `packageHashUrl` string
        - `packageUrl` string, required
      - `upgradeSource` string
    - `workers` WorkersTypeSystemSettingsConf, required
      - `count` number, required
      - `enableHeapSnapshots` boolean
      - `loadThrottlePerc` number
      - `memory` number, required
      - `minimum` number, required
      - `startupMaxConns` number
      - `startupThrottleTimeout` number
      - `v8SingleThread` boolean

## Other responses

- `401` — Unauthorized
- `500` — Unexpected error

## Changes

- **2026-01-19** `62472462b0c0` — 1 breaking
  - api path removed without deprecation
  - …this revision’s changelog is incomplete
- **2025-12-01** `adb53b98a4c5` — 1 breaking
  - api path removed without deprecation
- **2025-12-01** `df34abcdfc7c` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/criblio/apis/cribl-api-reference/changes/system/settings/conf/patch.md)

---

[API](https://skmtc.dev/criblio/apis/cribl-api-reference.md) · [All operations](https://skmtc.dev/criblio/apis/cribl-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/criblio/cribl-api-reference/revisions/11df16b26c1d/schema)