InlineApiServiceConfig1

JSON Example

{
    "basic_authentication_enabled": false,
    "cipher_suites": [
        {
            "enabled": false,
            "name": "string"
        }
    ],
    "client_api_concurrency_limit": 0,
    "client_api_rate_limit": 0,
    "connection_timeout": 0,
    "cookie_based_authentication_enabled": false,
    "global_api_concurrency_limit": 0,
    "lockout_immune_addresses": [
        "string"
    ],
    "protocol_versions": [
        "ProtocolVersion Object"
    ],
    "redirect_host": "string",
    "session_timeout": 0
}

boolean

basic_authentication_enabled

Optional

Constraints: default: true

Identifies whether basic authentication is enabled or disabled in API calls.

array of CipherSuite

cipher_suites

Optional

Constraints: minItems: 1

The TLS cipher suites that the API service will negotiate.

integer As int64 As int64

client_api_concurrency_limit

Optional

Constraints: minimum: 0 default: 40

A per-client concurrency limit. This is the maximum number of outstanding requests that a client can have. For example, a client can open multiple connections to NSX and submit operations on each connection. When this limit is exceeded, the server returns a 503 Service Unavailable error to the client. To disable API concurrency limiting, set this value to 0.

integer As int64 As int64

client_api_rate_limit

Optional

Constraints: minimum: 0 default: 100

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 As int64 As int64

connection_timeout

Optional

Constraints: minimum: 0 maximum: 2147483647 default: 30

NSX connection timeout, in seconds. To disable timeout, set to 0.

boolean

cookie_based_authentication_enabled

Optional

Constraints: default: true

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.

integer As int64 As int64

global_api_concurrency_limit

Optional

Constraints: minimum: 0 default: 199

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.

array of string

lockout_immune_addresses

Optional

The list of IP addresses which are not subjected to a lockout on failed login attempts.

array of ProtocolVersion

protocol_versions

Optional

Constraints: minItems: 1

The TLS protocol versions that the API service will negotiate.

string As /^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(?:\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\.?$|^$/

redirect_host

Optional

Constraints: default:

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 ("").

integer As int64 As int64

session_timeout

Optional

Constraints: minimum: 0 maximum: 2147483647 default: 1800

NSX session inactivity timeout

Used By

ApiServiceConfig