General

Tests the given proxy connection and returns every individual test step together with an overall summary. The summary is 'success' when every step passes, 'partial_success' when the website could be reached through at least one of IPv4, IPv6 or DNS name and the IP location lookup also succeeded, otherwise 'failure'.

Changed on
post/general/test-proxy

Request

Request body

Example request

{
  "proxy": {
    "extra": {
      "host": "127.0.0.1",
      "port": 9951,
      "id": "username",
      "secret": "password"
    }
  }
}

Response

OK.

result'success' | 'partial_success' | 'failure' required

Summarizes the overall outcome of a proxy connectivity test. Possible values: 'success': Every test step passed. 'partial_success': The website could be reached through at least one of IPv4, IPv6 or DNS name, and the IP location lookup succeeded. 'failure': None of the connectivity checks succeeded.

Example response

{
  "steps": [
    {
      "name": "Testing direct internet connectivity by pinging a remote host",
      "successful": true,
      "comment": "Proxy authentication failed"
    }
  ]
}

Changes