Change Power State

Change Power State

Changes the VM power state

Request
URI
PUT
https://{api_host}/api/vms/{id}/power
COPY
Path Parameters
string
id
Required

ID of VM

Request Body

VM power operation: on, off, shutdown, suspend

string of type(s) application/vnd.vmware.vmw.rest-v1+json
Required
Authentication
This operation uses the following authentication methods.
Responses
200

VM power state

Returns VMPowerState of type(s) application/vnd.vmware.vmw.rest-v1+json 
{
    "power_state": "string"
}
string
power_state
Required

power_state

Possible values are : poweredOn, poweredOff, suspended,

400

Invalid parameters

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json 
{
    "code": 0,
    "message": "string"
}
integer As int32 As int32
code
Required

code

string
message
Required

message


401

Authentication failed

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json 
{
    "code": 0,
    "message": "string"
}
integer As int32 As int32
code
Required

code

string
message
Required

message


403

Permission denied

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json 
{
    "code": 0,
    "message": "string"
}
integer As int32 As int32
code
Required

code

string
message
Required

message


404

No such resource

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json 
{
    "code": 0,
    "message": "string"
}
integer As int32 As int32
code
Required

code

string
message
Required

message


406

Content type was not supported

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json 
{
    "code": 0,
    "message": "string"
}
integer As int32 As int32
code
Required

code

string
message
Required

message


409

Resource state conflicts

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json 
{
    "code": 0,
    "message": "string"
}
integer As int32 As int32
code
Required

code

string
message
Required

message


500

Server error

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json 
{
    "code": 0,
    "message": "string"
}
integer As int32 As int32
code
Required

code

string
message
Required

message


default

Unexpected error

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json 
{
    "code": 0,
    "message": "string"
}
integer As int32 As int32
code
Required

code

string
message
Required

message


On This Page
VM Power Management Operations
PUT
Change Power State
GET
Get Power State