HttpServiceProperties

HTTP Service properties

JSON Example

{
    "basic_authentication_enabled": false,
    "certificate": {
        "category": "string",
        "details": [
            {
                "dsa_public_key_g": "string",
                "dsa_public_key_p": "string",
                "dsa_public_key_q": "string",
                "dsa_public_key_y": "string",
                "ecdsa_curve_name": "string",
                "ecdsa_ec_field": "string",
                "ecdsa_ec_field_f2mks": [
                    0
                ],
                "ecdsa_ec_field_f2mm": 0,
                "ecdsa_ec_field_f2mrp": "string",
                "ecdsa_ec_field_f2pp": "string",
                "ecdsa_pub": "string",
                "ecdsa_public_key_a": "string",
                "ecdsa_public_key_b": "string",
                "ecdsa_public_key_cofactor": 0,
                "ecdsa_public_key_generator_x": "string",
                "ecdsa_public_key_generator_y": "string",
                "ecdsa_public_key_order": "string",
                "ecdsa_public_key_seed": [
                    "string"
                ],
                "is_ca": false,
                "is_valid": false,
                "issuer": "string",
                "issuer_cn": "string",
                "not_after": 0,
                "not_before": 0,
                "parsed_pem_encoding": "string",
                "public_key_algo": "string",
                "public_key_length": 0,
                "rsa_public_key_exponent": "string",
                "rsa_public_key_modulus": "string",
                "serial_number": "string",
                "sha_256_thumbprint": "string",
                "signature": "string",
                "signature_algorithm": "string",
                "subject": "string",
                "subject_alt_names": {
                    "dns_names": [
                        "string"
                    ],
                    "ip_addresses": [
                        "string"
                    ]
                },
                "subject_cn": "string",
                "version": "string"
            }
        ],
        "has_private_key": false,
        "leaf_certificate_sha_256_thumbprint": "string",
        "pem_encoded": "string",
        "purpose": "string",
        "used_by": [
            {
                "node_id": "string",
                "service_types": [
                    "string"
                ]
            }
        ]
    },
    "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,
    "logging_level": "string",
    "protocol_versions": [
        {
            "enabled": false,
            "name": "string"
        }
    ],
    "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.

Certificate

certificate

Optional

certificate

array of CipherSuite

cipher_suites

Optional

Constraints: minItems: 1

Cipher suites used to secure contents of connection

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

NSX connection timeout, set to 0 to configure no timeout

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: 100

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.

string

logging_level

Optional

Constraints: default: INFO

Service logging level

Possible values are : OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE,

array of ProtocolVersion

protocol_versions

Optional

Constraints: minItems: 1

TLS protocol versions

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

integer As int64 As int64

session_timeout

Optional

Constraints: minimum: 0 maximum: 2147483647

NSX session inactivity timeout, set to 0 to configure no timeout