Vcenter Deployment Install cancel

Vcenter Deployment Install cancel

Cancel the appliance installation that is in progress.

This operation was added in vSphere API 6.7.

Request
URI
POST
https://{api_host}/api/vcenter/deployment/install?action=cancel
COPY
Authentication
This operation uses the following authentication methods.
Responses
204

Success!

Operation doesn't return any data structure

400

if the appliance is not in CONFIG_IN_PROGRESS state and if the operation is not INSTALL.

Returns Vapi Std Errors NotAllowedInCurrentState of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotAllowedInCurrentState0 
{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

401

if the caller is not authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/api/vcenter/deployment/install?action=cancel
On This Page
Vcenter Operations
GET
Vcenter Deployment Install get
POST
Vcenter Deployment Install check
POST
Vcenter Deployment Install start
POST
Vcenter Deployment Install cancel