REST API - list

content library subscriptions: list

Lists the subscriptions of the published library. This operation was added in vSphere API 6.7.2.

Request:

HTTP request

GET https://{server}/rest/com/vmware/content/library/subscriptions

?library=obj-103

Request Query Parameters:

Name	Type	Description
bold = required
library	string	Identifier of the published library.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : [
        {
            "subscribed_library" : "obj-103",
            "subscribed_library_name" : "string",
            "subscription" : "obj-103",
            "subscribed_library_vcenter_hostname" : "string"
        },
        {
            "subscribed_library" : "obj-103",
            "subscribed_library_name" : "string",
            "subscription" : "obj-103",
            "subscribed_library_vcenter_hostname" : "string"
        }
    ]
}

Response Type:

Name	Type	Description
bold = required
value	summary[]	List of commonly used information about subscriptions of the published library.
value[].subscription	string	Identifier of the subscription. This attribute was added in vSphere API 6.7.2. 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`.
value[].subscribed_library	string	Identifier of the subscribed library. This attribute was added in vSphere API 6.7.2. 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`.
value[].subscribed_library_name	string	Name of the subscribed library. This attribute was added in vSphere API 6.7.2.
value[].subscribed_library_vcenter_hostname	string	Hostname of the vCenter instance where the subscribed library exists. This attribute was added in vSphere API 6.7.2. Optional. This field is unset if the subscribed library is on the same vCenter Server instance as the published library.

Errors:

HTTP Status Code	Type	Description
500	error	If the system reports an error while responding to the request.
400	invalid_element_type	If the library specified by `library` is a subscribed library.
404	not_found	If the library specified by `library` does not exist.
400	not_allowed_in_current_state	If the library specified by `library` is not a published library.
401	unauthenticated	If the user that requested the operation cannot be authenticated.
403	unauthorized	If the user that requested the operation is not authorized to perform the operation.