VCenter Connections Inspect Certificate

VCenter Connections Inspect Certificate
Inspect the TLS certificate of a vCenter endpoint before any credential is entered

Reads the certificate the endpoint presents using only its host name and port. No username, password or token is accepted or sent. When the certificate needs an administrator decision the response carries a single-use trustChallengeId that Test Connection then uses to pin exactly that certificate. Loopback, link-local and multicast targets are refused, concurrent inspections are limited, and pending approvals are bounded. Requires the ADMIN role.

Request
URI
POST
https://{api_host}/api/v1/vcenter-connections/inspect-certificate
COPY
Request Body

The endpoint to inspect: host and port only.

InspectVCenterCertificateRequest of type(s) application/json
Required  

Show optional properties

{
    "host": "string"
}
{
    "host": "vcenter.example.com",
    "port": 443
}
string
host
Required  
Constraints: minLength: 1 maxLength: 255

vCenter host name or IP address (no scheme, path or user information)

integer As int32 As int32
port
Optional
Constraints: minimum: 1 maximum: 65535 default: 443

vCenter HTTPS port

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The presented certificate with its identity, validity and validation status

Returns VCenterCertificateInspection of type(s) application/json
{
    "host": "vcenter.example.com",
    "port": 443,
    "trustStatus": "REVIEW_REQUIRED",
    "tlsFailureReason": "UNTRUSTED_CA",
    "certificate": {
        "subject": "CN=vcenter.example.com,O=Example Org",
        "issuer": "CN=vcenter.example.com,O=Example Org",
        "validFrom": "2026-01-01T00:00:00Z",
        "validTo": "2026-03-31T00:00:00Z",
        "sha256Fingerprint": "01:23:45:67:89:AB:CD:EF:01:23:45:67:89:AB:CD:EF:01:23:45:67:89:AB:CD:EF:01:23:45:67:89:AB:CD:EF",
        "isExpired": false,
        "subjectAlternativeNames": [
            "vcenter.example.com"
        ]
    },
    "trustChallengeId": "00000000-0000-4000-8000-000000000041",
    "message": "Compare the fingerprint with the one shown on the vCenter and approve it only if it matches."
}
string
host
Required  

Inspected host

integer As int32 As int32
port
Required  

Inspected port

string
trustStatus
Required  

TRUSTED needs no approval, REVIEW_REQUIRED needs an administrator to approve this exact certificate, NOT_TRUSTABLE is expired, not yet valid or failed the handshake

Enumeration: TRUSTED, REVIEW_REQUIRED, NOT_TRUSTABLE
tlsFailureReason
Optional

Why strict validation failed, absent when TRUSTED

object
certificate
Optional

Presented X.509 certificate presentation and health details

string
trustChallengeId
Optional

Single-use challenge to send with Test Connection when trustStatus is REVIEW_REQUIRED

string
message
Required  

Plain-language guidance, contains no credentials


400

400 Bad Request: MISSING_FIELD when host is missing or blank; INVALID_PORT when port is outside 1 to 65535; INVALID_HOST when host is not a plain host name or IP address; HOST_UNRESOLVABLE when the name does not resolve; HOST_NOT_ALLOWED when it resolves to a loopback, link-local or multicast address; TOO_MANY_TRUST_CHALLENGES when too many approvals are pending

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


401

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


403

403 Forbidden: FORBIDDEN when the signed-in role is not allowed to call this operation; CSRF_ERROR when the X-XSRF-TOKEN header is missing or wrong on a POST, PUT, PATCH or DELETE (only POST /api/v1/auth/login is exempt, and a request without a valid session gets 401 UNAUTHENTICATED instead); PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)

Returns ForbiddenWrite of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


409

409 Conflict: CERTIFICATE_UNREADABLE when the endpoint presents no readable certificate; INSPECTION_BUSY when too many inspections are running

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"host":"string"}' https://{api_host}/api/v1/vcenter-connections/inspect-certificate