restart-required
Download SpecVerify if restart is required for given settings scope.
scope
string
required
- 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
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
oauth
Required Scopes:
admin
settings-manage
Verify if restart is required for given settings scope.
All Scopes
-
admin
· Admin scope - used for built-in PrivX admin account -
service
· Microservice scope - used for communication between PrivX microservices -
settings-manage
· Client with settings-manage scope -
settings-view
· Client with settings-view scope
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Request
{
"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
OK
{
"restart": true,
"settings": {
"db": {
"conn_max_idletime": true,
"conn_max_lifetime": true,
"max_idle_conns": true,
"max_open_conns": true
},
"housekeeping": {
"data_retention_period": true,
"housekeeping_interval": false,
"status_check_interval": true,
"system_health_check_interval": false,
"cache_db_expiry_interval": false,
"verify_disk_mounts": false
}
}
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization missing or invalid
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization OK but scope insufficient
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Resource not found
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
restart
boolean
required
settings
object (settings)
required
Settings scope map of require restart flags
- Example
- { "db": { "conn_max_idletime": true, "conn_max_lifetime": true, "max_idle_conns": true, "max_open_conns": true }, "housekeeping": { "data_retention_period": true, "housekeeping_interval": false, "status_check_interval": true, "system_health_check_interval": false, "cache_db_expiry_interval": false, "verify_disk_mounts": false } }
additionalProperties
object (additionalProperties)
additionalProperties
boolean
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing the error
details
array[]
An array of errors describing the error in more detail
reference (error)
recursiveWas this page helpful?