VCenter Connections Abandon Local Removal

VCenter Connections Abandon Local Removal
Abandon the Console records of an unreachable vCenter

Exceptional, explicitly authorized local retirement. It removes the Console records only. Hosts without a confirmed outcome become LOCAL_ABANDONED, Agent ownership history, the unconfirmed-offboarding evidence and the suppression of automatic enrollment are kept, and no host is reported unenrolled. It never authorizes enrolling the host here or in another Console. Allowed only from ATTENTION_REQUIRED after at least one retry. Requires the ADMIN role.

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

vCenter connection id: its numeric primary key, with or without the db- prefix. The connection row may be gone; the operation record is looked up by the numeric key

id example
1

Request Body

The operation id and generation the administrator was shown, the typed confirmation phrase, a reason and the acknowledgement that Agents may still be enrolled.

AbandonLocalRemovalRequest of type(s) application/json
Required  

Show optional properties

{
    "operationId": 0,
    "generation": 0,
    "confirmationPhrase": "string",
    "reasonCode": "string",
    "acknowledgeAgentsMayStillBeEnrolled": false
}
{
    "operationId": 7,
    "generation": 3,
    "confirmationPhrase": "ABANDON Primary vCenter",
    "reasonCode": "PERMANENTLY_UNREACHABLE",
    "reasonText": "vCenter was decommissioned",
    "acknowledgeAgentsMayStillBeEnrolled": true
}
integer As int64 As int64
operationId
Required  

Removal operation the caller was shown, so another operation is never abandoned by mistake

integer As int32 As int32
generation
Required  

Pass number the caller was shown; a newer pass answers 409 REMOVAL_STALE

string
confirmationPhrase
Required  

The exact phrase ABANDON followed by a space and the connection's display name, typed by the administrator

string
reasonCode
Required  

Reason an administrator gives for abandoning the Console records of a vCenter that cannot be reached.

  • DECOMMISSIONED: The vCenter was taken out of service on purpose
  • PERMANENTLY_UNREACHABLE: The vCenter cannot be reached and will not come back
  • REPLACED: A different vCenter replaced it
  • OTHER: Any other reason, explained in the reason text
Enumeration: DECOMMISSIONED, PERMANENTLY_UNREACHABLE, REPLACED, OTHER
string
reasonText
Optional
Constraints: maxLength: 200

Optional explanation, at most 200 characters, kept in the audit record

boolean
acknowledgeAgentsMayStillBeEnrolled
Required  

Must be true: the administrator accepts that Agents of hosts without a confirmed outcome may still be enrolled to this Console

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK: the operation is LOCALLY_ABANDONED

Returns VCenterRemovalOperation of type(s) application/json
{
    "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
}
integer As int64 As int64
operationId
Required  

Identifier of this removal operation

integer As int64 As int64
connectionPk
Required  

Primary key the connection had, kept after the row is deleted

string
displayName
Required  

Display name the connection had when the removal started

string
host
Required  

Address the connection had when the removal started

integer As int32 As int32
port
Required  

HTTPS port the connection had when the removal started

string
state
Required  

Where the operation stands: REQUESTED, RUNNING, ATTENTION_REQUIRED, COMPLETED or LOCALLY_ABANDONED

string
attentionReason
Optional

Why the operation stopped for the operator while ATTENTION_REQUIRED: HOST_FAILURES, INTERRUPTED, LATE_ENROLLMENT or FINALIZE_FAILED; null otherwise

integer As int32 As int32
generation
Required  

Pass number, increased by every retry and by a restart interruption

integer As int32 As int32
hostsTotal
Required  

Hosts the operation tracks, including hosts that appeared after it started

object
progress
Required  

Where a vCenter removal stands while Agent unenrollment runs on the enrollment workers. Counts use the offboarding outcome vocabulary

string
requestedBy
Required  

Account that started the removal

string As date-time As date-time
requestedAt
Required  

Moment an administrator asked for the removal, in UTC

string
lastRetryBy
Optional

Account that last started a retry; null before the first retry

string As date-time As date-time
lastRetryAt
Optional

When the last retry started; null before the first retry

string
abandonedBy
Optional

Account that abandoned the Console records; null unless LOCALLY_ABANDONED

string As date-time As date-time
abandonedAt
Optional

When the Console records were abandoned; null unless LOCALLY_ABANDONED

string
abandonReasonCode
Optional

Reason code given at abandonment: DECOMMISSIONED, PERMANENTLY_UNREACHABLE, REPLACED or OTHER; null unless LOCALLY_ABANDONED

string As date-time As date-time
finishedAt
Optional

When the operation reached COMPLETED or LOCALLY_ABANDONED; null while it is active

boolean
connectionDeleted
Required  

True once the connection row was deleted

boolean
canRetry
Required  

Whether Retry Removal may be started now

boolean
canAbandonLocal
Required  

Whether local abandonment may be requested now: ATTENTION_REQUIRED after at least one retry


202

202 Accepted: the forced local retirement of the hosts is still running; follow it with GET /api/v1/vcenter-connections/{id}/removal until the state is LOCALLY_ABANDONED

Returns VCenterRemovalOperation of type(s) application/json
{
    "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
}
integer As int64 As int64
operationId
Required  

Identifier of this removal operation

integer As int64 As int64
connectionPk
Required  

Primary key the connection had, kept after the row is deleted

string
displayName
Required  

Display name the connection had when the removal started

string
host
Required  

Address the connection had when the removal started

integer As int32 As int32
port
Required  

HTTPS port the connection had when the removal started

string
state
Required  

Where the operation stands: REQUESTED, RUNNING, ATTENTION_REQUIRED, COMPLETED or LOCALLY_ABANDONED

string
attentionReason
Optional

Why the operation stopped for the operator while ATTENTION_REQUIRED: HOST_FAILURES, INTERRUPTED, LATE_ENROLLMENT or FINALIZE_FAILED; null otherwise

integer As int32 As int32
generation
Required  

Pass number, increased by every retry and by a restart interruption

integer As int32 As int32
hostsTotal
Required  

Hosts the operation tracks, including hosts that appeared after it started

object
progress
Required  

Where a vCenter removal stands while Agent unenrollment runs on the enrollment workers. Counts use the offboarding outcome vocabulary

string
requestedBy
Required  

Account that started the removal

string As date-time As date-time
requestedAt
Required  

Moment an administrator asked for the removal, in UTC

string
lastRetryBy
Optional

Account that last started a retry; null before the first retry

string As date-time As date-time
lastRetryAt
Optional

When the last retry started; null before the first retry

string
abandonedBy
Optional

Account that abandoned the Console records; null unless LOCALLY_ABANDONED

string As date-time As date-time
abandonedAt
Optional

When the Console records were abandoned; null unless LOCALLY_ABANDONED

string
abandonReasonCode
Optional

Reason code given at abandonment: DECOMMISSIONED, PERMANENTLY_UNREACHABLE, REPLACED or OTHER; null unless LOCALLY_ABANDONED

string As date-time As date-time
finishedAt
Optional

When the operation reached COMPLETED or LOCALLY_ABANDONED; null while it is active

boolean
connectionDeleted
Required  

True once the connection row was deleted

boolean
canRetry
Required  

Whether Retry Removal may be started now

boolean
canAbandonLocal
Required  

Whether local abandonment may be requested now: ATTENTION_REQUIRED after at least one retry


400

400 Bad Request: CONFIRMATION_MISMATCH, ACKNOWLEDGEMENT_REQUIRED or INVALID_ARGUMENT

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.


404

404 Not Found: REMOVAL_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: REMOVAL_NOT_ABANDONABLE, REMOVAL_STALE or REMOVAL_IN_PROGRESS

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>' -H 'Content-Type: application/json' -d '{"operationId":"integer","generation":"integer","confirmationPhrase":"string","reasonCode":"string","acknowledgeAgentsMayStillBeEnrolled":"boolean"}' https://{api_host}/api/v1/vcenter-connections/{id}/removal/abandon-local