{
"additionalProperties": false,
"description": "Properties that affect the configuration of the NSX API service.",
"extends": {
"$ref": "ManagedResource
},
"id": "ApiServiceConfig",
"module_id": "ApiServiceConfig",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"title": "Generation of this resource config",
"type": "int"
},
"_schema": {
"readonly": true,
"title": "Schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true,
"title": "Link to this resource"
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"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"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"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"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"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"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"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"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"title": "Configuration of the API service",
"type": "object"
}