List Subscriptions
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
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}/rest/com/vmware/content/library/subscriptions
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
LibrarySubscriptionsListResponseBody
of type application/json
List of commonly used information about subscriptions of the published library.
{
"value": [
{
"subscribed_library": "string",
"subscribed_library_name": "string",
"subscribed_library_vcenter_hostname": "string",
"subscription": "string"
}
]
}| Property Name | Type | Description |
|---|---|---|
| value | array of LibrarySubscriptionsSummary |
List of commonly used information about subscriptions of the published library. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/com/vmware/content/library/subscriptions?library=string
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_element_type : If the library specified by library is a subscribed library. |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthenticated : If the user that requested the operation cannot be authenticated. | com.vmware.vapi.std.errors.unauthorized : If the user that requested the operation is not authorized to perform the operation. |
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : If the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : If the library specified by library does not exist. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.not_allowed_in_current_state : If the library specified by library is not a published library. |
| default | ErrorRest | Not available |
Subscriptions Operations
post
patch
delete
