Skip to main content
POST
/
global_ip_health_checks
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const globalIPHealthCheck = await client.globalIPHealthChecks.create();

console.log(globalIPHealthCheck.data);
{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "sample_record_type",
    "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"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
health_check_type
string

The Global IP health check type.

Example:

"http_status_2xx"

​
health_check_params
object

A Global IP health check params.

Example:
{ "path": "/", "port": 8080 }
​
global_ip_id
string<uuid>

Global IP ID.

Example:

"a836125b-20b6-452e-9c03-2653f09c7ed7"

Response

Successful response

​
data
Global IP health check · object