VCenter Connections List

VCenter Connections List
List all registered vCenter connections

Returns all configured vCenter connections with connection and trust health metadata. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.

Request
URI
GET
https://{api_host}/api/v1/vcenter-connections
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The registered vCenter connections with their connection and trust health

Returns VCenterConnectionListResponse of type(s) application/json
{
    "items": [
        {
            "id": "1",
            "displayName": "Primary vCenter",
            "host": "vcenter.example.com",
            "port": 443,
            "username": "svcvtp.example",
            "enabled": true,
            "vcenterInstanceUuid": "00000000-0000-4000-8000-000000000021",
            "trustProvenance": "USER_APPROVED",
            "certSha256": "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",
            "certSubject": "CN=vcenter.example.com,O=Example Org",
            "certNotAfter": "2026-03-31T00:00:00Z",
            "lastConnectionStatus": "WATCHING",
            "lastConnectionSecurityCode": "NONE",
            "createdAt": "2026-01-15T09:20:00Z",
            "discoveredHostCount": 12,
            "discoveredHostCountStatus": "READY",
            "lastVerifiedSyncAt": "2026-01-15T09:20:00Z",
            "inventoryHoldReason": null,
            "inventoryHoldObservedHosts": null,
            "inventoryHoldCurrentHosts": null,
            "inventoryHoldId": null,
            "inventoryHoldExcludedProductHosts": null,
            "removalProgress": null
        }
    ]
}
array of object
items
Required  

Configured vCenter connections


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: 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 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 -H 'Authorization: <value>' https://{api_host}/api/v1/vcenter-connections