[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vrms-appliance-config-api

Probe SSL

Description

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

Request

Request

URL

URL


post
https://{api_host}//appliance/certificates/server/actions/probe-ssl-connection
Copy

Request Body

Request Body

ProbeSslSpec of mimetype application/json Optional

URI of the endpoint to be probed.

{
	"uri": "string"
}
string
uri Required

URI to probe.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ApplianceX509CertificateDrResponseEntity of type application/json

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

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	},
	"certificate": "string",
	"extended_key_usage": [
		"string"
	],
	"issuer_alternative_names": [
		"string"
	],
	"issuer_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
	"issuer_unique_id": [
		false
	],
	"key_usage": [
		false
	],
	"not_after": 0,
	"not_before": 0,
	"public_key": "string",
	"public_key_algorithm": "RSA",
	"public_key_format": "X.509",
	"serial_number": "string",
	"sig_alg_name": "SHA256withRSA",
	"sig_alg_oid": "1.2.840.10040.4.3",
	"signature": "string",
	"subject_alternative_names": [
		"string"
	],
	"subject_dn": "C=US, OU=DR Division, O=\"VMware, Inc.\", CN=\"VMware, Inc.\"",
	"subject_unique_id": [
		false
	],
	"thumbprint": "string",
	"trusted": false,
	"version": 3
}
_meta Optional

Response meta data. Contains data about the response payload data.

Errors

Errors

ResponseError
400

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


401

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


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"uri":"string"}' https://{api_host}/appliance/certificates/server/actions/probe-ssl-connection


[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vrms-appliance-config-api
Feedback

Was this page helpful?