Get Library Item
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Returns the information about the library item associated with the virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/library-item
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
VmLibraryItemGetResponseBody
of type application/json
Information about the library item associated with the virtual machine.
{
"value": {
"check_out": {
"library_item": "string"
}
}
}| Property Name | Type | Description |
|---|---|---|
| value | VmLibraryItemInfo |
Information about the library item associated with the virtual machine. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}/library-item
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | ErrorRest | 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 | ErrorRest | com.vmware.vapi.std.errors.not_found : if the virtual machine is not found. |
| default | ErrorRest | Not available |
