Test

Tests a connection, including SSL handshake and hostname verification.

Request

URI

POST

https://{api_host}/cloudapi/1.0.0/testConnection

COPY

Request Body

Connection of type(s) application/json

Required

{
    "host": "string",
    "port": 0,
    "secure": false,
    "timeout": 0,
    "hostnameVerificationAlgorithm": "string",
    "additionalCAIssuers": [
        "string"
    ],
    "proxyConnection": {
        "proxyHost": "string",
        "proxyPort": 0,
        "proxyUsername": "string",
        "proxyPassword": "string",
        "proxySecure": false
    },
    "preConfiguredProxy": "string"
}

string

host

Required

The host (or IP address) to connect to.

integer

port

Required

The port to use when connecting.

boolean

secure

Optional

If the connection should use https.

integer As int32 As int32

timeout

Optional

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

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.

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

ProxyConnection

proxyConnection

Optional

proxyConnection

string

preConfiguredProxy

Optional

The URN of a ProxyConfiguration to use for the test. Only one of proxyConnection or preConfiguredProxy can be specified. If neither is specified then no proxy is used to test the connection.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns TestResult of type(s) application/json;version=38.0

{
    "targetProbe": {
        "result": "string",
        "resolvedIp": "string",
        "canConnect": false,
        "sslHandshake": false,
        "connectionResult": "string",
        "sslResult": "string",
        "certificateChain": "string",
        "additionalCAIssuers": [
            "string"
        ]
    },
    "proxyProbe": {
        "result": "string",
        "resolvedIp": "string",
        "canConnect": false,
        "sslHandshake": false,
        "connectionResult": "string",
        "sslResult": "string",
        "certificateChain": "string",
        "additionalCAIssuers": [
            "string"
        ]
    }
}

ProbeResult

targetProbe

Optional

targetProbe

ProbeResult

proxyProbe

Optional

proxyProbe

Availability

Added in 34.0

On This Page

Description