Hypervisors Api Authorize Recovery

Hypervisors Api Authorize Recovery
Authorize recovery of a host after a forced reset

Releases the recovery marker left by a forced reset on fresh evidence from this request: the host's own Agent reports UNENROLLED in a read-only status check (AGENT_REPORTS_UNENROLLED), or no Agent answers and a live Agent software check conclusively finds the VIB uninstalled (VIB_NOT_INSTALLED). Neither is a signed confirmation or cryptographic proof: this is an administrative exception recorded with the operator and the reason. It unenrolls and releases nothing on the host, sends no command to the Agent, never enrolls the host and never re-enables Auto Enrollment. Every refusal changes nothing. Requires the ADMIN role: a signed-in Administrator, or an API token that has Full access, is owned by an Administrator and is allowed to write Hypervisors by the token route policy (the default is read only, so a token is refused until an administrator raises the Hypervisors family to Read and write). The audit event records the principal, its type (SESSION or API_TOKEN) and the token id, never the token secret. For a host whose vCenter connection a durable removal disabled (REMOVING or ATTENTION_REQUIRED), only the read-only Agent status check may use that connection, through a one-host status-probe grant that ends with the call; the Agent software check is not available then.

Request
URI
POST
https://{api_host}/api/v1/hypervisors/{id}/enrollment/authorize-recovery
COPY
Path Parameters
integer
id
Required  

Hypervisor key

id example
102

Request Body

The operator's reason, kept in the audit log

AuthorizeRecoveryRequestDto of type(s) application/json
Required  

Show optional properties

{
    "reason": "string"
}
{
    "reason": "VIB reinstalled on the host; Agent confirmed UNENROLLED"
}
string
reason
Required  
Constraints: minLength: 10 maxLength: 500

Why the operator authorizes recovery; trimmed, then 10 to 500 characters

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The host after recovery and the evidence that supported it

Returns AuthorizeRecoveryResultDto of type(s) application/json
{
    "hypervisorPk": 102,
    "enrollmentStatus": "NOT_ENROLLED",
    "enrollmentStage": "NONE",
    "evidenceKind": "AGENT_REPORTS_UNENROLLED"
}
integer As int64 As int64
hypervisorPk
Required  

Hypervisor key

string
enrollmentStatus
Required  

Always NOT_ENROLLED after a recovery; recovery never enrolls the host

string
enrollmentStage
Required  

Always NONE after a recovery

string
evidenceKind
Required  

The evidence that supported the recovery. Neither is a signed confirmation by the Agent

Enumeration: AGENT_REPORTS_UNENROLLED, VIB_NOT_INSTALLED

400

400 Bad Request: INVALID_ARGUMENT when the id path variable is not a number, VALIDATION_FAILED when the reason is missing or longer than 500 characters, or INVALID_RECOVERY_REASON when the trimmed reason is not 10 to 500 characters

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 or CSRF_ERROR. 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 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: HYPERVISOR_NOT_FOUND

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.


409

409 Conflict: RECOVERY_NOT_REQUIRED, RECOVERY_BLOCKED_IN_FLIGHT, RECOVERY_IDENTITY_UNPROVEN or RECOVERY_AGENT_NOT_UNENROLLED

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 '{"reason":"string"}' https://{api_host}/api/v1/hypervisors/{id}/enrollment/authorize-recovery