Skip to content

Start Virtual Machine Instance

Initialize and power on a virtual machine instance by providing its unique identifier. This operation transitions the instance from a stopped state to an active running state.

HTTP Request

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

Path Parameters

ParameterRequirementTypeDescription
idRequiredstringTarget 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 instance initialization request.

Implementation Example

Request

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

Response

json
{
    "status": true,
    "message": "Instance initialization process initiated successfully"
}