Global IPs

List all Global IP health checks

Changed on

Returns a paginated list of the Global IP health checks configured on your account.

get/global_ip_health_checks

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/global_ip_health_checks
  • Auth: HTTP bearer

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Response

Successful response

Example response

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "global_ip_health_check",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "health_check_type": "http_status_2xx",
      "health_check_params": {
        "path": "/",
        "port": 8080
      },
      "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

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

    • breaking

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

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

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

    • breaking

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