VCenter Connections Create Retrust Challenge

VCenter Connections Create Retrust Challenge
Read the certificate a vCenter presents now and issue a re-trust challenge

Opens a TLS handshake to the connection's host and port only to read the presented leaf certificate; no credential is sent. When it differs from the pinned certificate a single-use trustChallengeId is returned for use with PUT trusted-certificate. An expired or not-yet-valid certificate is never offered. Requires the ADMIN role.

Request
URI
POST
https://{api_host}/api/v1/vcenter-connections/{id}/trust-challenge
COPY
Path Parameters
string
id
Required  

vCenter connection id

id example
1

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The presented certificate and, when it differs from the trusted one, a single-use challenge.

Returns VCenterRetrustChallengeDto of type(s) application/json
{
    "trustChallengeId": "00000000-0000-4000-8000-000000000042",
    "certificateChanged": true,
    "currentCertSha256": "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",
    "presentedCertificate": {
        "subject": "CN=vcenter.example.com,O=Example Org",
        "issuer": "CN=Example Issuing CA,O=Example Org",
        "validFrom": "2026-01-01T00:00:00Z",
        "validTo": "2026-03-31T00:00:00Z",
        "sha256Fingerprint": "00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00",
        "isExpired": false,
        "subjectAlternativeNames": [
            "vcenter.example.com"
        ]
    },
    "reason": "The vCenter presents a different certificate. Compare the fingerprints and approve it only if you replaced the certificate on this vCenter."
}
string
trustChallengeId
Optional

Single-use challenge identifier; null when the presented certificate is already trusted

boolean
certificateChanged
Required  

False when the vCenter presents the certificate that is already trusted

string
currentCertSha256
Required  

Fingerprint of the certificate currently pinned

object
presentedCertificate
Required  

Presented X.509 certificate presentation and health details

string
reason
Required  

Plain-language guidance for the administrator


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 or CSRF_ERROR. ADMIN role required.

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.


404

404 Not Found: CONNECTION_NOT_FOUND

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.


409

409 Conflict: SOURCE_REMOVING, CERTIFICATE_UNREADABLE or CERTIFICATE_NOT_TRUSTABLE

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
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>' https://{api_host}/api/v1/vcenter-connections/{id}/trust-challenge