This API has a deprecated equivalent from v7.0U1.
List Subscriptions
Lists the subscriptions of the published library. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter library requires System.Read.
Request
URLURL
https://{api_host}/api/content/library/{library}/subscriptions
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.
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
LibrarySubscriptionsSummary
of type application/json
List of commonly used information about subscriptions of the published library.
[
{
"subscribed_library": "string",
"subscribed_library_name": "string",
"subscribed_library_vcenter_hostname": "string",
"subscription": "string"
}
]
string
subscribed_library
Required
Identifier of the subscribed library. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.Library.
string
subscribed_library_name
Required
Name of the subscribed library.
string
subscription
Required
Identifier of the subscription. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.library.Subscriptions. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.library.Subscriptions.
string
subscribed_library_vcenter_hostname
Optional
Hostname of the vCenter instance where the subscribed library exists. This field is unset if the subscribed library is on the same vCenter Server instance as the published library.
Errors
400
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.
500
com.vmware.vapi.std.errors.error : If the system reports an error while responding to the request.
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
Invoke-ListLibraryContentSubscriptions -Library "MyLibrary"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/content/library/{library}/subscriptions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/com/vmware/content/library/subscriptions
x-vmw-doc-operation: list
Availability
Added in 7.0U2
On This Page
Subscriptions Operations
post
patch
delete
