Shutdown Appliance

Shutdown Appliance

Shut down the virtual appliance.

Request
URI
POST
https://{api_host}/appliance/actions/stop
COPY
Authentication
This operation uses the following authentication methods.
Responses
204

The appliance is shutting down.

Operation doesn't return any data structure

400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


On This Page
Appliance Operations
GET
Get Appliance Disks
GET
Get Appliance Info
GET
Get Syslog Servers
GET
Get Time Settings
GET
Get Time Zones
POST
Restart Appliance
POST
Send Syslog Test Message
POST
Shutdown Appliance
POST
Update Appliance Password
POST
Update Database Password
PUT
Update Syslog Servers
PUT
Update Time Settings