REST API - test
  1. Operations
  2. appliance
  3. networking
  4. dns
  5. servers

appliance networking dns servers: test

Test if dns servers are reachable.

Request:

HTTP request

POST https://{server}/rest/appliance/networking/dns/servers/test

Request Body Structure:

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

Request Body Parameters:

Name Type Description
bold = required
servers string[] DNS servers.

Response:

HTTP Status Code: 200

Representation:

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

Response Type:

Name Type Description
bold = required
value test_status_info DNS reacable 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