VCenter Connections Get Removal By Id
Reads one removal operation. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.
Removal operation id
7
200 OK: the removal operation
{
"operationId": 7,
"connectionPk": 1,
"displayName": "Primary vCenter",
"host": "vcenter.example.com",
"port": 443,
"state": "ATTENTION_REQUIRED",
"attentionReason": "HOST_FAILURES",
"generation": 3,
"hostsTotal": 120,
"progress": {
"operationId": 7,
"operationState": "ATTENTION_REQUIRED",
"attentionReason": "HOST_FAILURES",
"hostsTotal": 120,
"hostsFinished": 119,
"hostsFailed": 1,
"hostsOutstanding": 0,
"remoteConfirmed": 117,
"noRemoteIdentity": 2,
"forcedUnconfirmed": 0,
"recoveryRequired": 1
},
"requestedBy": "alice.example",
"requestedAt": "2026-01-15T09:30:00Z",
"lastRetryBy": "alice.example",
"lastRetryAt": "2026-01-15T09:40:00Z",
"abandonedBy": null,
"abandonedAt": null,
"abandonReasonCode": null,
"finishedAt": null,
"connectionDeleted": false,
"canRetry": true,
"canAbandonLocal": true
}
Identifier of this removal operation
Primary key the connection had, kept after the row is deleted
Display name the connection had when the removal started
Address the connection had when the removal started
HTTPS port the connection had when the removal started
Where the operation stands: REQUESTED, RUNNING, ATTENTION_REQUIRED, COMPLETED or LOCALLY_ABANDONED
Why the operation stopped for the operator while ATTENTION_REQUIRED: HOST_FAILURES, INTERRUPTED, LATE_ENROLLMENT or FINALIZE_FAILED; null otherwise
Pass number, increased by every retry and by a restart interruption
Hosts the operation tracks, including hosts that appeared after it started
Where a vCenter removal stands while Agent unenrollment runs on the enrollment workers. Counts use the offboarding outcome vocabulary
Account that started the removal
Moment an administrator asked for the removal, in UTC
Account that last started a retry; null before the first retry
When the last retry started; null before the first retry
Account that abandoned the Console records; null unless LOCALLY_ABANDONED
When the Console records were abandoned; null unless LOCALLY_ABANDONED
Reason code given at abandonment: DECOMMISSIONED, PERMANENTLY_UNREACHABLE, REPLACED or OTHER; null unless LOCALLY_ABANDONED
When the operation reached COMPLETED or LOCALLY_ABANDONED; null while it is active
True once the connection row was deleted
Whether Retry Removal may be started now
Whether local abandonment may be requested now: ATTENTION_REQUIRED after at least one retry
400 Bad Request: INVALID_ARGUMENT when the operation id is not a number
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
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 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
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 Not Found: REMOVAL_NOT_FOUND
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/vcenter-connections/removals/{operationId}