This API has a deprecated equivalent from v7.0U1.
Update Subscriptions
Updates the specified subscription of the published library. This is an incremental update to the subscription. Except for the Subscriptions.UpdateSpecPlacement structure, fields that are unset in the update specification will be left unchanged. If spec#subscribedLibraryPlacement is specified, all fields of the current subscribed library placement will be replaced by this placement.
if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.UpdateSubscription.
Request
URLURL
https://{api_host}/api/content/library/{library}/subscriptions/{subscription}
Path Parameters
Path Parameters
string
library
Required
Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.
string
subscription
Required
subscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions.
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
LibrarySubscriptionsUpdateSpec of mimetype application/json
Required
Specification of the new property values to set on the subscription.
{
"subscribed_library_placement": {
"cluster": "string",
"folder": "string",
"host": "string",
"network": "string",
"resource_pool": "string"
},
"subscribed_library_vcenter": {
"hostname": "string",
"https_port": 0
}
}
subscribed_library_placement
Optional
Placement specification for the virtual machine template items of the subscribed library. Updating this information will only affect new or updated items, existing items will not be moved. The entire placement configuration of the subscribed library will replaced by the new specification. If unset, the placement configuration of the subscribed library will be unchanged.
subscribed_library_vcenter
Optional
Specification for the subscribed library’s vCenter Server instance. If unset, the value is unchanged.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If Subscriptions.UpdateSpec contains invalid arguments. | com.vmware.vapi.std.errors.invalid_element_type : If the library specified by library is a subscribed library. | com.vmware.vapi.std.errors.not_allowed_in_current_state : If the library specified by library is not a published library.
401
com.vmware.vapi.std.errors.unauthenticated : If the user that requested the operation cannot be authenticated.
403
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 specified by library does not exist. If the subscription specified by subscription does not exist for the library specified by library.
500
com.vmware.vapi.std.errors.error : If the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_inaccessible : If the subscribed library cannot be contacted or found.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$LibrarySubscriptionsUpdateSpecVcenter = Initialize-LibrarySubscriptionsUpdateSpecVcenter -Hostname "MyHostname" -HttpsPort 0
$LibrarySubscriptionsUpdateSpecPlacement = Initialize-LibrarySubscriptionsUpdateSpecPlacement -Folder "MyFolder" -Cluster "MyCluster" -ResourcePool "MyResourcePool" -VarHost "MyVarHost" -Network "MyNetwork"
$LibrarySubscriptionsUpdateSpec = Initialize-LibrarySubscriptionsUpdateSpec -SubscribedLibraryVcenter $LibrarySubscriptionsUpdateSpecVcenter -SubscribedLibraryPlacement $LibrarySubscriptionsUpdateSpecPlacement
Invoke-UpdateLibrarySubscriptionContent -Library "MyLibrary" -Subscription "MySubscription" -LibrarySubscriptionsUpdateSpec $LibrarySubscriptionsUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"subscribed_library_placement":{"cluster":"string","folder":"string","host":"string","network":"string","resource_pool":"string"},"subscribed_library_vcenter":{"hostname":"string","https_port":0}}' https://{api_host}/api/content/library/{library}/subscriptions/{subscription}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: patch
x-vmw-doc-deprecated-path: /rest/com/vmware/content/library/subscriptions/id:{library}
x-vmw-doc-operation: update
Availability
Added in 7.0U2
On This Page
Subscriptions Operations
post
patch
delete
