Telnyx

JavaScript

import Telnyx from 'telnyx';

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

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

console.log(globalIPHealthCheck.data);

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

POST

global_ip_health_checks

JavaScript

import Telnyx from 'telnyx';

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

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

console.log(globalIPHealthCheck.data);

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

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

Show child attributes

data.id

string<uuid>

Identifies the resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

data.record_type

string

Identifies the type of the resource. Identifies the type of the resource.

Example:

"global_ip_health_check"

data.created_at

string

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

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

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

Example:

"2018-02-02T22:25:27.521Z"

data.health_check_type

string

The Global IP health check type.

Example:

"http_status_2xx"

data.health_check_params

object

A Global IP health check params.

Example:

{ "path": "/", "port": 8080 }

data.global_ip_id

string<uuid>

Global IP ID.

Example:

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

List all Global IP health checks Retrieve a Global IP health check

⌘I

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup