Create Subscriptions
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
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}/rest/com/vmware/content/library/subscriptions/id:{library}
Path Parameters
Path 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 |
Request Body
Request Body
Contains LibrarySubscriptionsCreateRequestBody
of type application/json
(required)
{
"spec": {
"subscribed_library": {
"location": "enum",
"placement": {
"folder": "string",
"resource_pool": "string"
},
"target": "enum"
}
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | LibrarySubscriptionsCreateSpec |
Specification for the subscription. |
| optional | client_token | string |
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. |
Response
Response
Response BodyResponse Body
200 OK returns
LibrarySubscriptionsCreateResponseBody
of type application/json
Subscription identifier. The result will be an identifier for the resource type: com.vmware.content.library.Subscriptions.
{
"value": "string"
}| Property Name | Type | Description |
|---|---|---|
| value | string |
Subscription identifier. The result will be an identifier for the resource type: com.vmware.content.library.Subscriptions. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"client_token":"string","spec":{"subscribed_library":{"location":"enum","new_subscribed_library":{"automatic_sync_enabled":false,"description":"string","name":"string","on_demand":false,"storage_backings":[{"datastore_id":"string","storage_uri":"string","type":"enum"}]},"placement":{"cluster":"string","folder":"string","host":"string","network":"string","resource_pool":"string"},"subscribed_library":"string","target":"enum","vcenter":{"hostname":"string","https_port":0}}}}' https://{api_host}/rest/com/vmware/content/library/subscriptions/id:{library}
Errors
| Code | Returns | Description |
|---|---|---|
| 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. If the subscribed library specified by subscribedLibrary#subscribedLibrary does not exist at the vCenter instance specified by subscribedLibrary#vcenter. | com.vmware.vapi.std.errors.resource_inaccessible : If the vCenter instance specified by subscribedLibrary#vcenter cannot be contacted or found. |
| 409 | ErrorRest | 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.not_allowed_in_current_state : If the library specified by library is not a published library. |
| default | ErrorRest | Not available |
| 400 | ErrorRest | 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. |
| 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. |
On This Page
Subscriptions Operations
post
patch
delete
