NSX-T Data Center Global Manager REST API

ApiServiceConfig (type)

{
  "additionalProperties": false, 
  "description": "Properties that affect the configuration of the NSX API service.", 
  "id": "ApiServiceConfig", 
  "properties": {
    "basic_authentication_enabled": {
      "default": true, 
      "description": "Identifies whether basic authentication is enabled or disabled in API calls.", 
      "title": "Enable or disable basic authentication", 
      "type": "boolean"
    }, 
    "cipher_suites": {
      "description": "The TLS cipher suites that the API service will negotiate.", 
      "items": {
        "$ref": "CipherSuite
      }, 
      "minItems": 1, 
      "title": "Cipher suites used to secure contents of connection", 
      "type": "array"
    }, 
    "client_api_concurrency_limit": {
      "default": 40, 
      "description": "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.", 
      "minimum": 0, 
      "title": "Client API rate limit in calls", 
      "type": "integer"
    }, 
    "client_api_rate_limit": {
      "default": 100, 
      "description": "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.", 
      "minimum": 0, 
      "title": "Client API rate limit in calls per second", 
      "type": "integer"
    }, 
    "connection_timeout": {
      "default": 30, 
      "description": "NSX connection timeout, in seconds. To disable timeout, set to 0.", 
      "maximum": 2147483647, 
      "minimum": 0, 
      "title": "NSX connection timeout", 
      "type": "integer"
    }, 
    "cookie_based_authentication_enabled": {
      "default": true, 
      "description": "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.", 
      "title": "Enable or disable cookie-based authentication", 
      "type": "boolean"
    }, 
    "global_api_concurrency_limit": {
      "default": 199, 
      "description": "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.", 
      "minimum": 0, 
      "title": "Global API rate limit in calls", 
      "type": "integer"
    }, 
    "lockout_immune_addresses": {
      "description": "The list of IP addresses which are not subjected to a lockout on failed login attempts.", 
      "items": {
        "$ref": "IPAddress
      }, 
      "title": "IP addresses which are not subject to lockout on failed login attempts", 
      "type": "array"
    }, 
    "protocol_versions": {
      "description": "The TLS protocol versions that the API service will negotiate.", 
      "items": {
        "$ref": "ProtocolVersion
      }, 
      "minItems": 1, 
      "title": "TLS protocol versions", 
      "type": "array"
    }, 
    "redirect_host": {
      "$ref": "HostnameOrIPv4AddressOrEmptyString, 
      "default": "", 
      "description": "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 (\"\").", 
      "title": "Hostname/IP to use in redirect headers"
    }, 
    "session_timeout": {
      "default": 1800, 
      "descriptions": "Sessions inactive for more than this value are terminated. The value is given in seconds. Set to 0 to disable timeouts.", 
      "maximum": 2147483647, 
      "minimum": 0, 
      "title": "NSX session inactivity timeout", 
      "type": "integer"
    }
  }, 
  "title": "Configuration of the API service", 
  "type": "object"
}