[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Perform Virtual Machine Action By ID

Description

Perform an individual template virtual machine action by its id/name.

Request

Request

URL

URL


post
https://cloud.vmwarehorizon.com/admin/v2/templates/{templateId}/vms/{vmId}
Copy

Path Parameters

Path Parameters

string
templateId Required

ID of template containing the VM


string
vmId Required

ID of the virtual machine


Query Parameters

Query Parameters

string
action Optional

Action to perform: one of ‘powerOff’, ‘powerOn’, ‘restart’, ‘shutdown’


string
org_id Optional

Filter by orgId: non-super users can only query for their own orgIds


string
page Optional

Page number to retrieve.


string
size Optional

Size of each page.


array of string
sort Optional

Ascending/Descending. Format is property,{asc|desc} and default is ascending.

Parameter Serialization Style: form Explode:true

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

202 Accepted

Successfully accepted VirtualMachine action

Errors

Errors

401

Unauthorized


403

Forbidden


404

Not Found


500

Unexpected internal server error

Code Samples

Code Samples

cURL Command

curl -X POST https://cloud.vmwarehorizon.com/admin/v2/templates/{templateId}/vms/{vmId}


Feedback

Was this page helpful?