REST API - test

appliance techpreview ntp: test

Test the connection to a list of ntp servers.

Request:

HTTP request

POST https://{server}/rest/appliance/techpreview/ntp/test

Request Body Structure:

JSON
XML

{
    "servers": [
        "string",
        "string"
    ]
}

Request Body Parameters:

Name	Type	Description
bold = required
servers	string[]	List of host names or IP addresses of NTP servers.

Response:

HTTP Status Code: 200

{
    "value": {
        "messages": [
            {
                "message": "string",
                "result": "failure"
            },
            {
                "message": "string",
                "result": "failure"
            }
        ],
        "status": "orange"
    }
}

Response Type:

Name	Type	Description
bold = required
value	test_status_info	NTP connection status.
value.status	string	Overall status of tests run. Health indicator Value is one of: orange: In case data has more than one test, this indicates not all tests were successful green: All tests were successful for given data red: All tests failed for given data
value.messages	message[]	messages
value.messages[].message	string	message
value.messages[].result	string	result of the test Individual test result Value is one of: failure: message indicates the test failed. success: message indicates that the test was successful.

Errors:

HTTP Status Code	Type	Description
500	error	Generic error