Get Library
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Returns a given LibraryModel. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires System.Read.
Request
URLURL
https://{api_host}/rest/com/vmware/content/library/id:{library_id}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the library to return. The parameter must be an identifier for the resource type: com.vmware.content.Library. |
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
LibraryGetResponseBody
of type application/json
The LibraryModel instance with the specified libraryId.
{
"value": {
"creation_time": "string",
"description": "string",
"id": "string",
"last_modified_time": "string",
"last_sync_time": "string",
"name": "string",
"optimization_info": {
"optimize_remote_publishing": false
},
"publish_info": {
"authentication_method": "enum",
"current_password": "string",
"password": "string",
"persist_json_enabled": false,
"publish_url": "string",
"published": false,
"user_name": "string"
},
"server_guid": "string",
"storage_backings": [
{
"datastore_id": "string",
"storage_uri": "string",
"type": "enum"
}
],
"subscription_info": {
"authentication_method": "enum",
"automatic_sync_enabled": false,
"on_demand": false,
"password": "string",
"source_info": {
"source_library": "string",
"subscription": "string"
},
"ssl_thumbprint": "string",
"subscription_url": "string",
"user_name": "string"
},
"type": "enum",
"version": "string"
}
}| Property Name | Type | Description |
|---|---|---|
| value | LibraryModel |
The LibraryModel instance with the specified libraryId. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/com/vmware/content/library/id:{library_id}
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if the specified library does not exist. |
| default | ErrorRest | Not available |
