Endpoint

/v1/portal/ping

POST

Returns a connectivity report for each node to each provided remote host.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "v1_portal_ping_request",
  "type": "object",
  "properties": {
    "hosts": {
      "type": "array",
      "items": {
        "description": "IP addresses and TCP ports of nodes in the remote cluster",
        "type": "object",
        "properties": {
          "address": {
            "description": "address",
            "type": "string"
          },
          "port": {
            "description": "port",
            "type": "number"
          }
        }
      }
    },
    "peer_uuid": {
      "description": "Optional UUID of the peer cluster for verification",
      "type": "string"
    },
    "sample_count": {
      "description": "Number of calls to average each round trip over",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "v1_portal_ping_result",
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "description": "results",
        "type": "object",
        "properties": {
          "node": {
            "description": "Node that attempted the connection",
            "type": "number"
          },
          "host": {
            "description": "Remote host that was tested",
            "type": "object",
            "properties": {
              "address": {
                "description": "address",
                "type": "string"
              },
              "port": {
                "description": "port",
                "type": "number"
              }
            }
          },
          "state": {
            "type": "string",
            "enum": [
              "reachable",
              "unreachable",
              "rejected"
            ],
            "description": "Whether the host answered, could not be reached, or answered and rejected the connection:\n * `reachable` - HOST_REACHABLE,\n * `rejected` - HOST_REJECTED,\n * `unreachable` - HOST_UNREACHABLE"
          },
          "ping_ms": {
            "description": "Connection round trip time reported in milliseconds",
            "type": "number"
          },
          "unreachable_reason": {
            "description": "Why the connection was unreachable or rejected.",
            "type": "string"
          }
        }
      }
    }
  }
}