Update Orchestrator advanced properties

put

http://127.0.0.1:8080/gms/advancedProperties

Modifies one or more Orchestrator advanced properties. Validates each property against type and range constraints. Properties marked with isRestartRequired=true in metadata require GMS restart to take effect. Changes are logged to the system action log. Cloud orchestrators have restricted modifiable properties.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

JSON object with property key-value pairs. Include only properties to be modified. Changes are validated and logged in action log.

Request body for PUT /gms/advancedProperties. Include only properties to modify. Validates type, range, and cloud orchestrator restrictions.

excludeTables

boolean

Exclude statistics tables during GMS backup. Default: false.

denyApplianceOnDelete

boolean

Deny appliance access when deleted from Orchestrator. Default: true.

restRequestStatsCollection

boolean

Enable REST API request statistics collection. Default: true.

newSoftwareReleasesNotification

boolean

Enable notifications for new software releases. Default: true.

ContentSecurityPolicyHeaderEnabled

boolean

Enable Content Security Policy HTTP header for XSS protection. Requires restart. Default: true.

addUuidToZscalerLocationEnabled

boolean

Add UUID to Zscaler location name. Default: true.

pauseStatsCollectionDuringBackup

boolean

Pause statistics collection during backup. Default: false.

csrfProtection

boolean

Enable CSRF protection. Default: false for upgrades, true for new installs.

dashboardTabOnLogin

boolean

Show dashboard tab on login. Default: false.

useProxyInRestHttpAdapter

boolean

Use proxy for REST HTTP adapter. Requires restart. Default: true.

enableECOSSimulation

boolean

Enable ECOS simulation mode. Requires restart. Default: false.

enableLegacyApisSupport

boolean

Enable RBAC legacy API support. Requires restart. Default: false.

cc.enable

boolean

Enable Common Criteria compliance mode. Requires restart. Default: false.

showSwaggerRestApis

boolean

Show Swagger REST APIs in UI. Default: false.

useUppercaseLetterInPassword

boolean

Require uppercase letter in passwords. Default: true.

useLowercaseLetterInPassword

boolean

Require lowercase letter in passwords. Default: true.

useDigitInPassword

boolean

Require digit in passwords. Default: true.

useSpecialSymbolInPassword

boolean

Require special symbol in passwords. Default: true.

enforcePasswordCriteria

boolean

Enforce password complexity criteria. Cannot be disabled once enabled. Requires restart. Default: false.

portalProxySemaphoreEnabled

boolean

Enable portal proxy semaphore. Requires restart. Default: true.

mgmtInterface

string

Network interface for management. Requires restart. Cannot be modified on cloud orchestrators. Default: eth0.

excludedTableNames

string

Comma-separated table names to exclude from backup.

sslIncludeProtocols

string

Comma-separated SSL/TLS protocols to include. Requires restart. Default: TLSv1.2.

sslExcludeProtocols

string

Comma-separated SSL/TLS protocols to exclude. Requires restart. Default: SSL,SSLv3,SSLv2,SSLv2Hello,TLSv1,TLSv1.1.

sslIncludeCiphers

string

Regex patterns for SSL ciphers to include. Requires restart.

sslExcludeCiphers

string

Regex patterns for SSL ciphers to exclude. Requires restart.

jvmArgsAppend

string

Additional JVM arguments to append. Requires restart.

awsTgnmRegion

string

Default AWS region for Transit Gateway Network Manager. Default: us-west-2.

sshClientCiphers

string

Comma-separated SSH ciphers. Only alphanumeric, comma, hyphen allowed. Default: hmac-sha2-256,hmac-sha1-96,hmac-md5-96,hmac-md5,hmac-sha1,hmac-sha2-512.

interfaceBandwidthCheckPerTunnelOverhead

integer

≥ 1

Per-tunnel overhead for bandwidth check. Must be > 0.

interfaceBandwidthCheckRangePercentage

integer

≥ 1

Bandwidth check range percentage. Must be > 0.

interfaceBandwidthCheckMinimumNumberOfTunnels

integer

≥ 1

Minimum tunnels for bandwidth check. Must be > 0.

oauthRefreshTokenRefreshTime

integer

≥ 1

OAuth refresh token check interval in minutes. Must be > 0. Requires restart.

endToEndEncryptionKeyLifespanInDays

integer

≥ 1

End-to-end encryption key lifespan in days. Must be > 0. Requires restart.

applianceTopologyLinkThreshold

integer

≥ 1

Appliance topology link threshold. Must be > 0. Default: 1000.

resetTimerForFailedLoginAttempts(mins)

integer

≥ 1

Reset interval for failed login counter in minutes. Must be > 0. Default: 5.

portalProxySemaphoreValue

integer

≥ 1

Portal proxy semaphore value. Must be > 0. Requires restart. Default: 100.

portalMaxConnectionsPerRoute

integer

≥ 1

Max connections per route for portal client. Must be > 0. Requires restart. Default: 150.

jvmArgsMaxHeap(MB)

integer

≥ 4000

Maximum JVM heap size in MB. Must be >= 4000 or empty string. Requires restart.

user.passwordMinLen

integer

8 to 64

Minimum password length. Must be between 8-64. Requires restart. Default: 8.

passwordHistoryCount

integer

4 to 8

Number of previous passwords to remember. Must be between 4-8. Default: 8.

passwordExpireDays

integer

30 to 360

Password expiration days. Must be between 30-360. Default: 90.

notifyPasswordExpiryDays

integer

5 to 30

Days before password expiry to notify user. Must be between 5-30. Default: 7.

userInactiveDays

integer

0 to 360

Days of inactivity before user lockout. 0 to disable, or 30-360. Default: 0.

user.passwordFailedThreshold

integer

Max failed password attempts before lockout. Default: 4.

failedLoginAttemptThreshold

integer

Failed login attempts in 5 minutes to trigger alarm. Default: 5.

emailImagesMaxSize

integer

Max total size of images in email reports (MB). Default: 10.

bridgeCacheExpireTime

integer

Bridge cache entry expiration time in seconds. Requires restart. Default: 120.

restRequestTimeout

integer

HTTP request timeout for appliance communication in seconds. Requires restart. Default: 60.

jettyIdleTimeout

integer

Jetty server idle timeout in milliseconds. Requires restart. Default: 60000.

jettyAcceptQueueSize

integer

Jetty server accept queue size. Requires restart. Default: 1000.

dbPoolMaxConnections

integer

Maximum database connections in pool. Requires restart. Default: 1000.

dbPoolConnectionTimeout

integer

Max wait time for DB connection from pool (ms). Requires restart. Default: 30000.

dbPoolIdleTimeout

integer

Idle time before connection removal from pool (ms). Requires restart. Default: 120000.

dbPoolMinimumIdleConnections

integer

Minimum idle connections in pool. Requires restart. Default: 10.

dbPoolMaxConnectionLifeTime

integer

Maximum connection lifetime in pool (ms). Requires restart. Default: 300000.

dbPoolValidationTimeout

integer

Max time to validate connection aliveness (ms). Requires restart. Default: 3000.

dbPoolLeakDetectionThreshold

integer

Time before logging potential connection leak (ms). Requires restart. Default: 300000.

modifyTunnelBatchSize

integer

Tunnels to modify per batch operation. Default: 500.

bondedTunnelReorderWaitTime

integer

Bonded tunnel packet reordering wait time (ms). Default: 100.

fileOpsChunkSize

integer

Chunk size for file operations (bytes). Default: 1048576.

applianceUnreachableAlarmThreshold

integer

Seconds before raising appliance unreachable alarm. Default: 300.

portalUnreachableAlarmThreshold

integer

Seconds before raising portal unreachable alarm. Default: 900.

Responses

204

Properties updated successfully. No content returned.

401

Authentication credentials missing or invalid

403

User lacks READ_WRITE permission

500

Failed to update properties in database

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Validation failed for one or more properties