Create Subscribed Library
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Creates a new subscribed library. Once created, the subscribed library will be empty. If the LibraryModel.subscription-info property is set, the Content Library Service will attempt to synchronize to the remote source. This is an asynchronous operation so the content of the published library may not immediately appear.
if you do not have all of the privileges described as follows: - Operation execution requires ContentLibrary.CreateSubscribedLibrary. - The resource Datastore referenced by the attribute StorageBacking.datastore-id requires Datastore.AllocateSpace.
Request
URLURL
https://{api_host}/rest/com/vmware/content/subscribed-library
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains SubscribedLibraryCreateRequestBody
of type application/json
(required)
{
"create_spec": {}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | create_spec | LibraryModel |
Specification for the new subscribed library. |
| optional | client_token | string |
Unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified creation is not idempotent. |
Response
Response
Response BodyResponse Body
200 OK returns
SubscribedLibraryCreateResponseBody
of type application/json
Identifier of the newly created subscribed library. The result will be an identifier for the resource type: com.vmware.content.Library.
{
"value": "string"
}| Property Name | Type | Description |
|---|---|---|
| value | string |
Identifier of the newly created subscribed library. The result will be an identifier for the resource type: com.vmware.content.Library. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"client_token":"string","create_spec":{"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"}}' https://{api_host}/rest/com/vmware/content/subscribed-library
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.resource_inaccessible : if subscribing to a published library which cannot be accessed. |
| 405 | ErrorRest | com.vmware.vapi.std.errors.unsupported : if using multiple storage backings. |
| default | ErrorRest | Not available |
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : if the createSpec is not valid. if the clientToken does not conform to the UUID format. |
On This Page
Subscribed Library Operations
delete
