REST API - probe
  1. Operations
  2. vcenter
  3. ovf
  4. import session

vcenter ovf import session: probe

Request:

HTTP request

POST https://{server}/rest/com/vmware/vcenter/ovf/import-session?~action=probe

Request Body Structure:

{
    "ssl_certificate_thumbprint" : "string",
    "uri" : "http://myurl.com"
}

Request Body Parameters:

Name Type Description
bold = required
uri URI the pull source URI to be probed.
ssl_certificate_thumbprint string Optional. the thumbprint of the expected SSL certificate for this URI.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "ssl_thumbprint" : "string",
        "error_messages" : [
            {
                "args" : [
                    "string",
                    "string"
                ],
                "default_message" : "string",
                "localized" : "string",
                "id" : "string",
                "params" : [
                    {
                        "value" : {
                            "dt" : "2015-01-01T22:13:05.651Z",
                            "s" : "string",
                            "d" : 1.5,
                            "precision" : 1,
                            "format" : "SHORT_DATE",
                            "i" : 1,
                            "l" : {
                                "id" : "string",
                                "params" : [
                                    {
                                        "value" : {
                                            "dt" : "2015-01-01T22:13:05.651Z",
                                            "s" : "string",
                                            "d" : 1.5,
                                            "precision" : 1,
                                            "format" : "SHORT_DATE",
                                            "i" : 1,
                                            "l" : {
                                                "id" : "string",
                                                "params" : [
                                                    {
                                                        "key" : "string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key" : "string"
                                    }
                                ]
                            }
                        },
                        "key" : "string"
                    }
                ]
            },
            {
                "args" : [
                    "string",
                    "string"
                ],
                "default_message" : "string",
                "localized" : "string",
                "id" : "string",
                "params" : [
                    {
                        "value" : {
                            "dt" : "2015-01-01T22:13:05.651Z",
                            "s" : "string",
                            "d" : 1.5,
                            "precision" : 1,
                            "format" : "SHORT_DATE",
                            "i" : 1,
                            "l" : {
                                "id" : "string",
                                "params" : [
                                    {
                                        "value" : {
                                            "dt" : "2015-01-01T22:13:05.651Z",
                                            "s" : "string",
                                            "d" : 1.5,
                                            "precision" : 1,
                                            "format" : "SHORT_DATE",
                                            "i" : 1,
                                            "l" : {
                                                "id" : "string",
                                                "params" : [
                                                    {
                                                        "key" : "string"
                                                    }
                                                ]
                                            }
                                        },
                                        "key" : "string"
                                    }
                                ]
                            }
                        },
                        "key" : "string"
                    }
                ]
            }
        ],
        "status" : "SUCCESS"
    }
}

Response Type:

Name Type Description
bold = required
value probe_result the pull source URI probe result.
value.status string Status of the attempt to access the pull source URI.

Defines the possible status values from an attempt to access a pull source URI. 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.
CERTIFICATE_ERROR: Indicates that the provided server certificate thumbprint is invalid. In this case, the returned certificate thumbprint should be provided.
UNKNOWN_ERROR: Indicates an unspecified error different from the other error cases defined in vcenter.ovf.import_session.probe_result.status.
value.ssl_thumbprint string The SSL thumbprint for a pull source URI with the https scheme.

Optional. It is only relevant when status has value [CERTIFICATE_ERROR, SUCCESS, UNKNOWN_ERROR]. An SSL thumbprint is only returned if the host is secured with SSL/TLS.
value.error_messages localizable_message[] Detailed error messages if the the attempt to access the pull source URI failed.

Optional. It is only relevant when status has value [INVALID_URL, TIMED_OUT, HOST_NOT_FOUND, CERTIFICATE_ERROR, UNKNOWN_ERROR]. This field is optional and it is only relevant when the value of status is one of INVALID_URL, TIMED_OUT, HOST_NOT_FOUND, CERTIFICATE_ERROR, or UNKNOWN_ERROR.
value.error_messages[].id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
value.error_messages[].default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
value.error_messages[].args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.

Errors:

None