Start VM Instance

Initiates the startup of a virtual machine. Supply the virtual machine ID in the path to initiate the starting of the specified virtual machine.

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 start the virtual machine. true signifies success, while false indicates an error.

message string

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

Example

Request

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

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