| basic_authentication_enabled |
Enable or disable basic authentication
Identifies whether basic authentication is enabled or disabled in API calls. |
boolean |
Default: "True" |
| cipher_suites |
Cipher suites used to secure contents of connection
The TLS cipher suites that the API service will negotiate. |
array of CipherSuite |
Minimum items: 1 |
| client_api_concurrency_limit |
Client API rate limit in calls
The maximum number of concurrent API requests that will be serviced for a given authenticated client. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0. |
integer |
Minimum: 0
Default: "40" |
| client_api_rate_limit |
Client API rate limit in calls per second
The maximum number of API requests that will be serviced per second for a given authenticated client. If more API requests are received than can be serviced, a 429 Too Many Requests HTTP response will be returned. To disable API rate limiting, set this value to 0. |
integer |
Minimum: 0
Default: "100" |
| connection_timeout |
NSX connection timeout
NSX connection timeout, in seconds. To disable timeout, set to 0. |
integer |
Minimum: 0
Maximum: 2147483647
Default: "30" |
| cookie_based_authentication_enabled |
Enable or disable cookie-based authentication
Identifies whether cookie-based authentication is enabled or disabled in API calls. When cookie-based authentication is disabled, new sessions cannot be created via /api/session/create. |
boolean |
Default: "True" |
| global_api_concurrency_limit |
Global API rate limit in calls
The maximum number of concurrent API requests that will be serviced. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0. |
integer |
Minimum: 0
Default: "199" |
| lockout_immune_addresses |
IP addresses which are not subject to lockout on failed login attempts
The list of IP addresses which are not subjected to a lockout on failed login attempts. |
array of IPAddress |
|
| protocol_versions |
TLS protocol versions
The TLS protocol versions that the API service will negotiate. |
array of ProtocolVersion |
Minimum items: 1 |
| redirect_host |
Hostname/IP to use in redirect headers
Host name or IP address to use for redirect location headers, or empty string to derive from current request. To disable, set redirect_host to the empty string (""). |
HostnameOrIPv4AddressOrEmptyString |
Default: "" |
| session_timeout |
NSX session inactivity timeout |
integer |
Minimum: 0
Maximum: 2147483647
Default: "1800" |