Stop Virtual Machine Instance

Initiate a graceful shutdown sequence for a virtual machine instance. This operation requires the instance's unique identifier to commence the shutdown process.

HTTP Request

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

Path Parameters

Parameter	Requirement	Type	Description
id	Required	string	Target instance's unique identifier

Response Structure

status boolean

Operation result indicator. Returns true for successful execution, false when encountering an error.

message string

Descriptive response indicating the outcome of the shutdown request.

Implementation 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": "Instance shutdown sequence initiated successfully"
}