REST API - get

vcenter vm template library items check outs: get

Returns the information about a checked out virtual machine. This operation was added in vSphere API 6.9.1.

Request:

HTTP request

GET https://{server}/rest/vcenter/vm-template/library-items/{template_library_item}/check-outs/{vm}

Path Parameters

Name Type Description
Required
template_library_item string Identifier of the VM template library item.
vm string Identifier of the checked out virtual machine.

Response:

HTTP Status Code: 200

Representation:

{
    "value"{
        "time""2015-01-01T22:13:05.651Z",
        "user""string"
    }
}

Response Type:

Name Type Description
bold = required
value info Information about a check out.
value.time date_time Date and time when the virtual machine was checked out. This attribute was added in vSphere API 6.9.1.

value.user string Name of the user who checked out the virtual machine. This attribute was added in vSphere API 6.9.1.

Errors:

HTTP Status Code Type Description
404 not_found if the library item or virtual machine is not found.
400 invalid_argument if the virtual machine is not checked out of the library item.
401 unauthenticated if the user that requested the operation cannot be authenticated.
403 unauthorized if the user that requested the operation is not authorized to perform the operation.
500 error if the system reports an error while responding to the request.