Settings

settings

Download Spec

get/settings/api/v1/settings/{scope}

Get settings for the scope

mergeboolean

It signal whether service specific settings should be merged with shared settings.

Responses

Response examples

{
  "db": {
    "conn_max_idletime": 900,
    "conn_max_lifetime": 900,
    "max_idle_conns": 2,
    "max_open_conns": 20
  },
  "housekeeping": {
    "data_retention_period": 180,
    "housekeeping_interval": 8,
    "status_check_interval": 10,
    "system_health_check_interval": 1,
    "cache_db_expiry_interval": 300,
    "verify_disk_mounts": "/:5GB,/var/log:5GB,/var/privx/audit:10GB"
  }
}

put/settings/api/v1/settings/{scope}

Update settings for a scope.

Responses

Request examples

{
  "db": {
    "conn_max_idletime": 900,
    "conn_max_lifetime": 900,
    "max_idle_conns": 2,
    "max_open_conns": 20
  },
  "housekeeping": {
    "data_retention_period": 180,
    "housekeeping_interval": 8,
    "status_check_interval": 10,
    "system_health_check_interval": 1,
    "cache_db_expiry_interval": 300,
    "verify_disk_mounts": "/:5GB,/var/log:5GB,/var/privx/audit:10GB"
  }
}

Response examples

Empty response