vserver_shutdown ()
This function shuts down VPS.
| HTTP Method: | GET | |
|---|---|---|
| Parameters: | sid | session id* |
| vserver_id | unique id of VPS* | |
| force | specifies whether the server should be forced shut down if it does not shut down upon ACPI signal (shuts down cleanly). Default value is 1, available values are 1 and 0. | |
| Returns: | HTTP code | 200 (OK) |
| Function call successful - VPS is shutting down. Reply portion reply is empty. |
Return errors
| Error code | HTTP response code | Description |
|---|---|---|
| 1 | 400 (Bad request) | Function was not performed, because all required parameters were not entered. Reply portion reply is empty. |
| 3 | 403 (Forbidden) | Function call failed, invalid sid parameter. Create new sid using /api/login function. Reply portion reply is empty. |
| 5 | 403 (Forbidden) | Function has not been performed, because it is probably an attempt to manipulate VPS that is not in your administration. Reply portion reply is empty. |
CURL
curl "https://admin.hosting90.eu/api/vserver_shutdown?sid=%sid%&vserver_id=%vserver_id%"
PHP Library
$api->vserver_shutdown(array(
'vserver_id' => %vserver_id%,
));
Example of data output
<?xml version="1.0" encoding="UTF-8"?>
<reply>
<status>
<code>0</code>
<text>Server is shutdowning</text>
</status>
</reply>