This API has a deprecated equivalent from v7.0U1.
Publish Local Library
Publishes the library to specified subscriptions. If no subscriptions are specified, then publishes the library to all its subscriptions. if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.PublishLibrary.
Request
URLURL
https://{api_host}/api/content/local-library/{library_id}?action=publish
Path Parameters
Path Parameters
string
library_id
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
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
LocalLibraryPublishRequestBody of mimetype application/json
Optional
This is a request body class for an operation.
(The request body parameter is missing description)
{
"subscriptions": [
{
"subscription": "string"
}
]
}
array of
LocalLibraryDestinationSpec
subscriptions
Optional
The list of subscriptions to publish this library to.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If one or more subscriptions is not valid. | com.vmware.vapi.std.errors.invalid_element_type : If the library specified by libraryId is a subscribed library. | com.vmware.vapi.std.errors.not_allowed_in_current_state : If the library specified by libraryId 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 libraryId 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
$LocalLibraryDestinationSpec = Initialize-LocalLibraryDestinationSpec -Subscription "MySubscription"
$LocalLibraryPublishRequestBody = Initialize-LocalLibraryPublishRequestBody -Subscriptions $LocalLibraryDestinationSpec
Invoke-PublishLibraryIdLocalLibrary -LibraryId "MyLibraryId" -LocalLibraryPublishRequestBody $LocalLibraryPublishRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"subscriptions":[{"subscription":"string"}]}' https://{api_host}/api/content/local-library/{library_id}?action=publish
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/local-library/id:{library_id}?~action=publish
x-vmw-doc-operation: publish
Availability
Added in 7.0U2
On This Page
Local Library Operations
post
delete
patch
