This API has a deprecated equivalent from v7.0U1.
Probe Subscribed Library
Probes remote library subscription information, including URL, SSL certificate and password. The resulting SubscribedLibrary.ProbeResult structure describes whether or not the subscription configuration is successful. if you do not have all of the privileges described as follows: - Operation execution requires ContentLibrary.ProbeSubscription.
Request
URLURL
https://{api_host}/api/content/subscribed-library?action=probe
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
SubscribedLibraryProbeRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"subscription_info": {
"authentication_method": "BASIC",
"automatic_sync_enabled": false,
"on_demand": false,
"password": "string",
"source_info": {
"source_library": "string",
"subscription": "string"
},
"ssl_thumbprint": "string",
"subscription_url": "string",
"user_name": "string"
}
}
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
SubscribedLibraryProbeResult
of type application/json
The subscription info probe result.
{
"error_messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
],
"ssl_thumbprint": "string",
"status": "SUCCESS"
}
array of
StdLocalizableMessage
error_messages
Required
If the probe result is in an error status, this field will contain the detailed error messages.
status
Required
The SubscribedLibrary.ProbeResult.Status enumerated type defines the error status constants for the probe result.
SUCCESS : Indicates that the probe was successful.
INVALID_URL : Indicates that the supplied URL was not valid.
TIMED_OUT : Indicates that the probe timed out while attempting to connect to the URL.
HOST_NOT_FOUND : Indicates that the host in the URL could not be found.
RESOURCE_NOT_FOUND : Indicates that the given resource at the URL was not found.
INVALID_CREDENTIALS : Indicates that the connection was rejected due to invalid credentials.
CERTIFICATE_ERROR : Indicates that the provided server certificate thumbprint in SubscriptionInfo.ssl-thumbprint is invalid. In this case, the returned #sslThumbprint should be set in SubscriptionInfo.ssl-thumbprint.
UNKNOWN_ERROR : Indicates an unspecified error different from the other error cases defined in SubscribedLibrary.ProbeResult.Status.
Possible values are: SUCCESS , INVALID_URL , TIMED_OUT , HOST_NOT_FOUND , RESOURCE_NOT_FOUND , more...
string
ssl_thumbprint
Optional
The SSL thumbprint for the remote endpoint. An SSL thumbprint is only returned if the host is secured with SSL/TLS.
Errors
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
$LibrarySourceInfo = Initialize-LibrarySourceInfo -SourceLibrary "MySourceLibrary" -Subscription "MySubscription"
$LibrarySubscriptionInfo = Initialize-LibrarySubscriptionInfo -AuthenticationMethod "BASIC" -AutomaticSyncEnabled $false -OnDemand $false -Password "MyPassword" -SslThumbprint "MySslThumbprint" -SubscriptionUrl "MySubscriptionUrl" -UserName "MyUserName" -SourceInfo $LibrarySourceInfo
$SubscribedLibraryProbeRequestBody = Initialize-SubscribedLibraryProbeRequestBody -SubscriptionInfo $LibrarySubscriptionInfo
Invoke-ProbeContentSubscribedLibrary -SubscribedLibraryProbeRequestBody $SubscribedLibraryProbeRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"subscription_info":{"authentication_method":"BASIC","automatic_sync_enabled":false,"on_demand":false,"password":"string","source_info":{"source_library":"string","subscription":"string"},"ssl_thumbprint":"string","subscription_url":"string","user_name":"string"}}' https://{api_host}/api/content/subscribed-library?action=probe
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/subscribed-library?~action=probe
x-vmw-doc-operation: probe
Availability
Added in 7.0U2
On This Page
Subscribed Library Operations
delete
