v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB
Global IPs

Global IP Assignment Health Check Metrics

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": [
    {
      "timestamp": "2020-01-01T00:00:00.000Z",
      "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_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
        "wireguard_peer": {
          "name": "Wireguard Peer 1",
          "ip_address": "73.47.1.23"
        }
      },
      "health": {
        "pass": 100
      }
    }
  ]
}