REST API - list

vcenter vm template library items check outs: list

Returns commonly used information about the virtual machines that are checked out of the library item. 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

Path Parameters

Name Type Description
Required
template_library_item string Identifier of the VM template library item.

Response:

HTTP Status Code: 200

Representation:

{
    "value"[
        {
            "vm""obj-103"
        },
        {
            "vm""obj-103"
        }
    ]
}

Response Type:

Name Type Description
bold = required
value summary[] List of commonly used information about the check outs.
value[].vm string Identifier of the checked out virtual machine. This attribute was added in vSphere API 6.9.1.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: VirtualMachine. When operations return a value of this structure as a result, the field will be an identifier for the resource type: VirtualMachine.

Errors:

HTTP Status Code Type Description
404 not_found if the library item is not found.
400 invalid_argument if the library item does not contain a virtual machine template.
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.