Update VM

URI

PUT

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

COPY

Path Parameters

string

id

Required

ID of VM

---

Request Body

VM definition

VMParameter of type(s) application/vnd.vmware.vmw.rest-v1+json

Required

{
    "processors": 0,
    "memory": 0
}

integer As int32 As int32

processors

Optional

Constraints: default: 1

Number of processor cores

integer As int32 As int32

memory

Optional

Constraints: default: 512

Memory size in mega bytes

Responses

200

Hide Details

VM information

Returns VMInformation of type(s) application/vnd.vmware.vmw.rest-v1+json

"VMInformation Object"

string

id

Required

id

object

cpu

Optional

The CPU information of VM

integer As int32 As int32

memory

Optional

Constraints: default: 512

Memory size in mega bytes

400

Hide Details

Invalid parameters

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

401

Hide Details

Authentication failed

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

403

Hide Details

Permission denied

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

404

Hide Details

No such resource

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

406

Hide Details

Content type was not supported

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

409

Hide Details

Resource state conflicts

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

500

Hide Details

Server error

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

default

Hide Details

Unexpected error

Returns ErrorModel of type(s) application/vnd.vmware.vmw.rest-v1+json

"ErrorModel Object"

integer As int32 As int32

code

Required

code

string

message

Required

message

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/vnd.vmware.vmw.rest-v1+json' -d '{}' https://{api_host}/api/vms/{id}