POST Time Test

POST Time Test

Test connectivity to new NTP servers. May take up to 20 seconds per server listed.

Request
URI
POST
https://{api_host}/api/v1/time/test
COPY
Request Body
time.test.post.request of type(s) application/json
Optional 
{
    "ntpServers": [
        "0.vmware.pool.ntp.org",
        "1.vmware.pool.ntp.org",
        "2.vmware.pool.ntp.org",
        "3.vmware.pool.ntp.org"
    ]
}
Authentication
This operation uses the following authentication methods.
Responses
200

Successfully tested connectivity to NTP servers.

Returns time.test.post.response of type(s) application/json 
{
    "testedNTPServers": [
        {
            "server": "0.vmware.pool.ntp.org",
            "state": "pass"
        },
        {
            "server": "1.vmware.pool.ntp.org",
            "state": "pass"
        },
        {
            "server": "2.vmware.pool.ntp.org",
            "state": "pass"
        },
        {
            "server": "3.vmware.pool.ntp.org",
            "state": "fail"
        }
    ]
}

401

The request was refused because it lacks valid authentication credentials. This can happen if the Authorization header was missing, or if it contained an invalid session ID.

Obtain a new session ID and retry the request, or make an unauthenticated request without the Authorization header.

"Invalid session ID"

440

The request was refused because the session ID has expired. Obtain a new session ID from /api/v1/sessions.

"Login Timeout"

500

Internal error while processing the client request

Returns error of type(s) application/json 
{
    "errorMessage": "The operation failed due to an internal error."
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v1/time/test
On This Page
Time Operations
GET
GET Time
GET
GET Time Config
PUT
PUT Time Config
POST
POST Time Test