List Library Items Check Outs
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Returns commonly used information about the virtual machines that are checked out of the library item. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
Request
URLURL
https://{api_host}/rest/vcenter/vm-template/library-items/{template_library_item}/check-outs
Parameters
Parameters
string
template_library_item
Required
Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
VmTemplateLibraryItemsCheckOutsListResponseBody
of type application/json
List of commonly used information about the check outs.
{
"value": [
{
"vm": "string"
}
]
}
value
Optional
List of commonly used information about the check outs.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm-template/library-items/{template_library_item}/check-outs
Errors
401
com.vmware.vapi.std.errors.unauthenticated : if the user that requested the operation cannot be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user that requested the operation is not authorized to perform the operation.
404
com.vmware.vapi.std.errors.not_found : if the library item is not found. | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
400
com.vmware.vapi.std.errors.invalid_argument : if the library item does not contain a virtual machine template.
