Skip to main content
GET
/
global_ip_assignment_health
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const globalIPAssignmentHealth = await client.globalIPAssignmentHealth.retrieve();

console.log(globalIPAssignmentHealth.data);
{
  "data": [
    {
      "timestamp": "2020-01-01T00:00:00.000Z",
      "global_ip": {
        "id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
        "ip_address": null
      },
      "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,
        "fail": 0
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter
object

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

Response

Successful response

data
object[]