content library item updatesession file: probe
Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Request:
HTTP request
POST https://{server}/rest/com/vmware/content/library/item/updatesession/file?~action=probe
Request Body Structure:
{
"source_endpoint" : {
"ssl_certificate_thumbprint" : "string",
"uri" : "http://myurl.com"
}
}
"source_endpoint" : {
"ssl_certificate_thumbprint" : "string",
"uri" : "http://myurl.com"
}
}
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| source_endpoint | transfer_endpoint | the source endpoint to be probed. |
| source_endpoint.uri | URI | Transfer endpoint URI. The supported URI schemes are: http, https, and ds. An endpoint URI with the
When the transfer endpoint is a datastore location, the server can import the file directly from the storage backing without the overhead of streaming over HTTP. |
| source_endpoint.ssl_certificate_thumbprint | string | Thumbprint of the expected SSL certificate for this endpoint. Only used for HTTPS connections. The thumbprint is the SHA-1 hash of the DER encoding of the remote endpoint's SSL certificate. If set, the remote endpoint's SSL certificate is only accepted if it matches this thumbprint, and no other certificate validation is performed. Optional. If not specified, standard certificate validation is performed. |
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"
}
}
"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 source endpoint probe result. |
| value.status | string | Status of the attempt to access the source endpoint URI. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Defines the possible status values from an attempt to access a source endpoint URI. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: SUCCESS: Indicates that the probe was successful. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. INVALID_URL: Indicates that the supplied URL was not valid. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. TIMED_OUT: Indicates that the probe timed out while attempting to connect to the URL. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. HOST_NOT_FOUND: Indicates that the host in the URL could not be found. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. CERTIFICATE_ERROR: Indicates that the provided server certificate thumbprint in content.library.item.transfer_endpoint.ssl_certificate_thumbprint is invalid. In this case, the returned #sslThumbprint should be set in content.library.item.transfer_endpoint.ssl_certificate_thumbprint. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. UNKNOWN_ERROR: Indicates an unspecified error different from the other error cases defined in content.library.item.updatesession.file.probe_result.status. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| value.ssl_thumbprint | string | The SSL thumbprint for a source endpoint with the https scheme. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. 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 source endpoint URI failed. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. 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. |