Content SubscribedLibrary probe

Probes remote library subscription information, including URL, SSL certificate and password. The resulting Content SubscribedLibrary ProbeResult schema describes whether or not the subscription configuration is successful.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires ContentLibrary.ProbeSubscription.

Request

URI

POST

https://{api_host}/api/content/subscribed-library?action=probe

COPY

Request Body

Request body for invoking operation: probe

Show optional properties

{
    "subscription_info": {}
}

{
    "subscription_info": {
        "authentication_method": "string",
        "automatic_sync_enabled": false,
        "on_demand": false,
        "password": "string",
        "ssl_thumbprint": "string",
        "subscription_url": "string",
        "user_name": "string",
        "source_info": {
            "source_library": "string",
            "subscription": "string"
        },
        "ssl_certificate": "string"
    }
}

Content Library SubscriptionInfo

subscription_info

Required

The Content Library SubscriptionInfo schema defines the subscription behavior for a subscribed library.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

200

The subscription info probe result.

Returns Content SubscribedLibrary ProbeResult of type(s) application/json

"Content SubscribedLibrary ProbeResult Object"

string

status

Required

The status of probe result. This will be one of Status.

For more information see: Content SubscribedLibrary ProbeResult Status.

string

ssl_thumbprint

Optional

The SSL thumbprint for the remote endpoint.

A SSL thumbprint is only returned if the host is secured with SSL/TLS.

string

ssl_certificate

Optional

The SSL certificate for the remote endpoint.

This property was added in vSphere API 9.0.0.0.

A SSL certificate is only returned if the host is secured with SSL/TLS and if the {SubscribedLibrary#sslCertificate} is also set.

array of object

error_messages

Required

If the probe result is in an error status, this property will contain the detailed error messages.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"subscription_info:"object"}' https://{api_host}/api/content/subscribed-library?action=probe

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Content Operations

GET

Content SubscribedLibrary list

POST

Content SubscribedLibrary create