Global IPs

Create a Global IP health check

Changed on

Creates a health check for a Global IP to monitor the health of its assignments. Creation is asynchronous, so the request is accepted and the health check becomes active once provisioning completes.

post/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

Request body

idstring uuid

Identifies the resource.

record_typestring

Identifies the type of the resource.

created_atstring

ISO 8601 formatted date-time indicating when the resource was created.

updated_atstring

ISO 8601 formatted date-time indicating when the resource was updated.

health_check_typestring

The Global IP health check type.

health_check_paramsobject

A Global IP health check params.

global_ip_idstring uuid

Global IP ID.

Example request

{
  "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"
}

Response

Creation request accepted. Provisioning is asynchronous; poll GET /global_ip_health_checks/{id} with the returned id to check status.

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"
  }
}

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