Update Subscribed Library
Updates the properties of a subscribed library. This is an incremental update to the subscribed library. Fields that are unset in the update specification will be left unchanged.
if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.UpdateSubscribedLibrary.
Request
URLURL
https://{api_host}/rest/com/vmware/content/subscribed-library/id:{library_id}
Parameters
Parameters
string
library_id
Required
Identifier of the subscribed library to update.
The parameter must be an identifier for the resource type: com.vmware.content.Library.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
SubscribedLibraryUpdateRequestBody of type application/json (required){
"update_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"
}
}
update_spec
Required
Specification of the new property values to set on the subscribed library.
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"update_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/id:{library_id}
Errors
400
com.vmware.vapi.std.errors.invalid_element_type : if the library specified by libraryId is not a subscribed library. | com.vmware.vapi.std.errors.invalid_argument : if the updateSpec is not valid.
404
com.vmware.vapi.std.errors.not_found : if the library specified by libraryId does not exist. | com.vmware.vapi.std.errors.resource_inaccessible : if the subscription info is being updated but the published library cannot be contacted or found.
409
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the updateSpec updates the subscription URL (see SubscriptionInfo.subscription-url) and the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.storage-backings) associated with it. | com.vmware.vapi.std.errors.resource_busy : if the LibraryModel.version of updateSpec is unset and the library is being concurrently updated by another user. | com.vmware.vapi.std.errors.concurrent_change : if the LibraryModel.version of updateSpec is not equal to the current version of the library.
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.
On This Page
Subscribed Library Operations
delete
