Connection

Connection to test.


Properties

string
host Required

The host (or IP address) to connect to.


integer
port Required

The port to use when connecting.


array of string
additionalCAIssuers Optional

A list of URLs being authorized by the user to retrieve additional CA certificates from, if necessary, to complete the certificate chain to its trust anchor.

Upon retrieving the certificate chain presented during the handshake, if signing CA certificates were not included, but a location is specified for the ‘caIssuers’ access method of the ‘Authority Info Access’ extension (as described in RFC 5280 Section 4.2.2.1) of those certificates and that location is one of these supplied URLs, then additional certificates will be retrieved from those URLs in accordance with the protocol laid out in the RFC.

Any failure to retrieve this certificate will NOT fail the test connection request, nor will the error associated with this failure be returned.

In the unlikely event that the CA Issuers URL specifies https instead of http, the original certificate, that included that URL, will be temporarily used to trust the server during ssl handshake

Added in 36.0

string
hostnameVerificationAlgorithm Optional

Endpoint/Hostname verification algorithm to be used during SSL/TLS/DTLS handshake. Their values are as follows:

  • HTTPS: use https hostname verification algorithm as described in RFC 2818
  • LDAPS: use ldaps hostname verification algorithm as described in RFC 2830
When this field is not set, the default value null indicates no hostname verification will be performed.

Added in 36.0

proxyConnection Optional

Proxy connection to use for test. If none is specified, then no proxy is used to test the connection.


boolean
secure Optional

If the connection should use https.


integer as int32
timeout Optional

Maximum time (in seconds) any step in the test should wait for a response.

JSON Example

{
    "host": "string",
    "port": 0
}
Availability
Added in 34.0
Parameter To

Test
Feedback

Was this page helpful?