Get Power State

Returns the power state of the VM

Request

URI

GET

https://{api_host}/api/vms/{id}/power

COPY

Path Parameters

string

Required

ID of VM

Authentication

This operation uses the following authentication methods.

BasicAuth

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, paused, 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

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

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Vm Power Management Operations