REST API - probe

content subscribed library: probe result

The probe_result structure defines the subscription information probe result. This describes whether using a given subscription URL is successful or if there are access problems, such as SSL errors.

Representation:

JSON

{
    "error_messages": [
        {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        },
        {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        }
    ],
    "ssl_thumbprint": "string",
    "status": "SUCCESS"
}

Attributes:

Name	Type	Description
Required
status	string	The status of probe result. This will be one of `SUCCESS`, `INVALID_URL`, `TIMED_OUT`, `HOST_NOT_FOUND`, `RESOURCE_NOT_FOUND`, `INVALID_CREDENTIALS`, `CERTIFICATE_ERROR`, `UNKNOWN_ERROR`. Defines the error status constants for the probe result. Value is one of: 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 content.library.subscription_info.ssl_thumbprint is invalid. In this case, the returned #sslThumbprint should be set in content.library.subscription_info.ssl_thumbprint. UNKNOWN_ERROR: Indicates an unspecified error different from the other error cases defined in content.subscribed_library.probe_result.status.
error_messages	localizable_message[]	If the probe result is in an error status, this field will contain the detailed error messages.
Optional
ssl_thumbprint	string	The SSL thumbprint for the remote endpoint. Optional. An SSL thumbprint is only returned if the host is secured with SSL/TLS.