Sign in
Global IPs

Global IP Assignment Health Check Metrics

Retrieve health check metrics for your Global IP assignments.

get/global_ip_assignment_health

Query parameters

Consolidated filter parameter (deepObject style). Originally: filter[global_ip_id][in], filter[global_ip_assignment_id][in]

Response

Successful response

Example response

{
  "data": [
    {
      "global_ip": {
        "id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
        "ip_address": "192.0.2.1"
      },
      "global_ip_assignment": {
        "id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
        "wireguard_peer": {
          "ip_address": "73.47.1.23",
          "name": "Wireguard Peer 1"
        },
        "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320"
      },
      "health": {
        "pass": 100
      },
      "timestamp": "2020-01-01T00:00:00.000Z"
    }
  ]
}

Changes

Changed in 2 of the 61 revisions of this API.4

  • 1571b0380bd72See the full diff
    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379942See the full diff
    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog