This API has a deprecated equivalent from v7.0U1.
Get Subscriptions
Returns information about the specified subscription 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/{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
Identifier of the subscription. 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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
LibrarySubscriptionsInfo
of type application/json
Information about the subscription.
{
"subscribed_library": "string",
"subscribed_library_location": "LOCAL",
"subscribed_library_name": "string",
"subscribed_library_placement": {
"cluster": "string",
"folder": "string",
"host": "string",
"network": "string",
"resource_pool": "string"
},
"subscribed_library_vcenter": {
"hostname": "string",
"https_port": 0,
"server_guid": "string"
}
}
string
subscribed_library
Required
Identifier of the subscribed library associated with 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. 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.
subscribed_library_location
Required
The Subscriptions.Location enumerated type defines the location of subscribed library relative to the published library.
LOCAL : The subscribed library belongs to the same vCenter instance as the published library.
REMOTE : The subscribed library belongs to a different vCenter instance than the published library.
Possible values are: LOCAL , REMOTE
string
subscribed_library_name
Required
Name of the subscribed library associated with the subscription.
subscribed_library_placement
Required
Placement information about the subscribed library’s virtual machine template items.
subscribed_library_vcenter
Optional
Information about the vCenter Server instance where the subscribed library exists. This field is optional and it is only relevant when the value of Subscriptions.Info.subscribed-library-location is REMOTE.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If the subscription is not valid. | 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-GetLibrarySubscriptionContent -Library "MyLibrary" -Subscription "MySubscription"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" 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: post
x-vmw-doc-deprecated-path: /rest/com/vmware/content/library/subscriptions/id:{library}?~action=get
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Subscriptions Operations
post
patch
delete
