---
title: "Global IP Assignment Health Check Metrics"
method: GET
path: "/global_ip_assignment_health"
tags: ["Global IPs"]
---

# Global IP Assignment Health Check Metrics

`GET /global_ip_assignment_health`

## Query parameters

- `filter` object
  - `global_ip_id` union
    - string — Filter by exact Global IP ID
    - object — Filtering operations
      - `in` string — Filter by Global IP ID(s) separated by commas
  - `global_ip_assignment_id` union
    - string — Filter by exact Global IP Assignment ID
    - object — Filtering operations
      - `in` string — Filter by Global IP Assignment ID(s) separated by commas

## Response `200`

Successful response

- object
  - `data` GlobalIpAssignmentHealthMetric[]
    - `timestamp` string, date-time — The timestamp of the metric.
    - `global_ip` object
      - `id` string, uuid — Global IP ID.
      - `ip_address` string — The Global IP address.
    - `global_ip_assignment` object
      - `id` string, uuid — Global IP assignment ID.
      - `wireguard_peer_id` string, uuid — Wireguard peer ID.
      - `wireguard_peer` object
        - `name` string — A user specified name for the interface.
        - `ip_address` string — The IP address of the interface.
    - `health` object
      - `pass` number — The number of successful health checks.
      - `fail` number — The number of failed health checks.

## Other responses

- `422` — Unexpected error
- `default` — Unexpected error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/versions/8f5f4e537994/schema)