Probe Ssl

Probe Ssl

Check if the appliance can establish a successful SSL connection with the specified endpoint.

Request
URI
POST
https://{api_host}/appliance/certificates/server/actions/probe-ssl-connection
COPY
Request Body

URI of the endpoint to be probed.

ProbeSslSpec of type(s) application/json
Optional 
{
    "uri": "string"
}
string
uri
Required

URI to probe.

Authentication
This operation uses the following authentication methods.
Responses
200

Structure that describes if this appliance can validate the certificate coming from the specified endpoint.

Returns ApplianceX509CertificateDrResponseEntity of type(s) application/json
This response body class contains all of the following: ApplianceX509Certificate 
{
    "serial_number": "string",
    "not_after": 0,
    "not_before": 0,
    "signature": "string",
    "version": 3,
    "issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
    "subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
    "sig_alg_name": "SHA256withRSA",
    "sig_alg_oid": "1.2.840.10040.4.3",
    "public_key": "string",
    "public_key_format": "X.509",
    "public_key_algorithm": "RSA",
    "thumbprint": "string",
    "certificate": "string",
    "issuer_unique_id": [
        false
    ],
    "subject_unique_id": [
        false
    ],
    "key_usage": [
        false
    ],
    "issuer_alternative_names": [
        "string"
    ],
    "subject_alternative_names": [
        "string"
    ],
    "extended_key_usage": [
        "string"
    ],
    "trusted": false,
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}
Metadata
_meta
Optional

_meta


400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


On This Page
Certificates Operations
POST
Add Ca Certificates
POST
Delete Ca Certificates
POST
Generate Csr
GET
Get Appliance Ca Certificates
GET
Get Appliance Certificate
POST
Probe Ssl
POST
Update Appliance Certificate