This API has a deprecated equivalent from v7.0U1.
Create Subscriptions
Creates a 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 ContentLibrary.AddSubscription.
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
client_token
Optional
A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.
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
LibrarySubscriptionsCreateSpec of mimetype application/json
Required
Specification for the subscription.
{
"subscribed_library": {
"location": "LOCAL",
"placement": {
"folder": "string",
"resource_pool": "string"
},
"target": "CREATE_NEW"
}
}
subscribed_library
Required
Specification for the subscribed library to be associated with the subscription.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
string
of type application/json
Subscription identifier. The result will be an identifier for the resource type: com.vmware.content.library.Subscriptions.
Errors
400
com.vmware.vapi.std.errors.already_exists : If a subscription of the published library to the specified subscribed library already exists. This is only applicable when subscribedLibrary#subscribedLibrary is specified. | com.vmware.vapi.std.errors.invalid_argument : If Subscriptions.CreateSpec 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 subscribed library specified by subscribedLibrary#subscribedLibrary does not exist at the vCenter instance specified by subscribedLibrary#vcenter.
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 vCenter instance specified by subscribedLibrary#vcenter 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
$LibrarySubscriptionsCreateSpecPlacement = Initialize-LibrarySubscriptionsCreateSpecPlacement -Folder "MyFolder" -ResourcePool "MyResourcePool"
$LibrarySubscriptionsCreateSpecSubscribedLibrary = Initialize-LibrarySubscriptionsCreateSpecSubscribedLibrary -Target "CREATE_NEW" -Location "LOCAL" -Placement $LibrarySubscriptionsCreateSpecPlacement
$LibrarySubscriptionsCreateSpec = Initialize-LibrarySubscriptionsCreateSpec -SubscribedLibrary $LibrarySubscriptionsCreateSpecSubscribedLibrary
Invoke-CreateLibraryContentSubscriptions -Library "MyLibrary" -LibrarySubscriptionsCreateSpec $LibrarySubscriptionsCreateSpec
PowerCLI Client SDK All Parameters Example
$LibraryStorageBacking = Initialize-LibraryStorageBacking -Type "DATASTORE" -DatastoreId "MyDatastoreId" -StorageUri "MyStorageUri"
$LibrarySubscriptionsCreateSpecNewSubscribedLibrary = Initialize-LibrarySubscriptionsCreateSpecNewSubscribedLibrary -Name "MyName" -Description "MyDescription" -StorageBackings $LibraryStorageBacking -AutomaticSyncEnabled $false -OnDemand $false
$LibrarySubscriptionsCreateSpecVcenter = Initialize-LibrarySubscriptionsCreateSpecVcenter -Hostname "MyHostname" -HttpsPort 0
$LibrarySubscriptionsCreateSpecPlacement = Initialize-LibrarySubscriptionsCreateSpecPlacement -Folder "MyFolder" -Cluster "MyCluster" -ResourcePool "MyResourcePool" -VarHost "MyVarHost" -Network "MyNetwork"
$LibrarySubscriptionsCreateSpecSubscribedLibrary = Initialize-LibrarySubscriptionsCreateSpecSubscribedLibrary -Target "CREATE_NEW" -NewSubscribedLibrary $LibrarySubscriptionsCreateSpecNewSubscribedLibrary -SubscribedLibrary "MySubscribedLibrary" -Location "LOCAL" -Vcenter $LibrarySubscriptionsCreateSpecVcenter -Placement $LibrarySubscriptionsCreateSpecPlacement
$LibrarySubscriptionsCreateSpec = Initialize-LibrarySubscriptionsCreateSpec -SubscribedLibrary $LibrarySubscriptionsCreateSpecSubscribedLibrary
Invoke-CreateLibraryContentSubscriptions -Library "MyLibrary" -LibrarySubscriptionsCreateSpec $LibrarySubscriptionsCreateSpec -ClientToken "MyClientToken"
cURL Command
curl -X POST -H "client_token: string" -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"subscribed_library":{"location":"LOCAL","new_subscribed_library":{"automatic_sync_enabled":false,"description":"string","name":"string","on_demand":false,"storage_backings":[{"datastore_id":"string","storage_uri":"string","type":"DATASTORE"}]},"placement":{"cluster":"string","folder":"string","host":"string","network":"string","resource_pool":"string"},"subscribed_library":"string","target":"CREATE_NEW","vcenter":{"hostname":"string","https_port":0}}}' 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: post
x-vmw-doc-deprecated-path: /rest/com/vmware/content/library/subscriptions/id:{library}
x-vmw-doc-operation: create
Availability
Added in 7.0U2
On This Page
Subscriptions Operations
post
patch
delete
