settings

Download Spec

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

Get settings for the scope

merge

boolean

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

Response

ExamplesSchema

OK

{
  "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.

Response

ExamplesSchema

OK

Empty response

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

Get settings for the scope

scope

string

required

Scope of settings (GLOBAL, MONITOR-SERVICE, etc.)

Enum
  • AUTH
  • AUTHORIZER
  • CONNECTION-MANAGER
  • HOST-STORE
  • TRAIL-INDEX
  • KEYVAULT
  • MONITOR-SERVICE
  • RDP-PROXY
  • RDP-MITM
  • SSH-PROXY
  • SSH-MITM
  • ROLE-STORE
  • USER-STORE
  • WORKFLOW-ENGINE
  • SETTINGS
  • SEARCH
  • VAULT
  • LICENSE-MANAGER
  • SECRETS-MANAGER
  • NETWORK-ACCESS-MANAGER
  • EXTENDER-SERVICE
  • DB-PROXY
  • PRIVX-CARRIER
  • PRIVX-WEB-PROXY
  • PRIVX-EXTENDER
  • GLOBAL
  • UEBA

section

string

required

Section

Response

ExamplesSchema

OK

{
  "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}/{section}

Update settings for a scope and section combination.

Response

ExamplesSchema

OK

Empty response

Was this page helpful?