| _create_time |
Timestamp of resource creation |
EpochMsTimestamp |
Readonly
Sortable |
| _create_user |
ID of the user who created this resource |
string |
Readonly |
| _last_modified_time |
Timestamp of last modification |
EpochMsTimestamp |
Readonly
Sortable |
| _last_modified_user |
ID of the user who last modified this resource |
string |
Readonly |
| _links |
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink |
Readonly |
| _protection |
Indicates protection status of this resource
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.
|
string |
Readonly |
| _revision |
Generation of this resource config
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. |
int |
|
| _schema |
Schema for this resource |
string |
Readonly |
| _self |
Link to this resource |
SelfResourceLink |
Readonly |
| _system_owned |
Indicates system owned resource |
boolean |
Readonly |
| 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" |
| description |
Description of this resource |
string |
Maximum length: 1024
Sortable |
| display_name |
Identifier to use when displaying entity in logs or GUI
Defaults to ID if not set |
string |
Maximum length: 255
Sortable |
| 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" |
| id |
Unique identifier of this resource |
string |
Sortable |
| 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: "" |
| resource_type |
Must be set to the value ApiServiceConfig |
string |
|
| session_timeout |
NSX session inactivity timeout |
integer |
Minimum: 0
Maximum: 2147483647
Default: "1800" |
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |