Stop VM Instance

Shuts down a virtual machine. Provide the virtual machine ID in the path to initiate the shutdown process for the specified virtual machine.

NOTE

Please be informed that after a VM instance is stopped, it will remain intact and continues to incur charges. The VM instance can be restarted at any time. To completely release the VM instance, the delete operation must be performed.

HTTP Request

GET {API_URL}/virtual-machines/{id}/start

Path parameters

Parameters	Requirements	Type	Description
id	Required	string	The unique identifier of the virtual machine for which to retrieve details.

Reponse Attributes

status boolean

Indicates the result of the request to stop the virtual machine. true signifies success, while false indicates an error.

message string

A description of the status of the request to shutdown the virtual machine.

Example

Request

curl -X GET '{API_URL}virtual-machines/{id}/stop' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'refresh-token: {REFRESH_TOKEN}' \
-H 'Content-Type: application/json'

Response

{
    "status": true,
    "message": "Stopping virtual machine successful"
}