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.retrieve(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);
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"
}
}Retrieve a Global IP health check.
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.retrieve(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);
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"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Identifies the resource.
"6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Successful response
Show child attributes
Identifies the resource.
"6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Identifies the type of the resource.
"sample_record_type"
ISO 8601 formatted date-time indicating when the resource was created.
"2018-02-02T22:25:27.521Z"
ISO 8601 formatted date-time indicating when the resource was updated.
"2018-02-02T22:25:27.521Z"
The Global IP health check type.
"http_status_2xx"
A Global IP health check params.
{ "path": "/", "port": 8080 }Global IP ID.
"a836125b-20b6-452e-9c03-2653f09c7ed7"
Was this page helpful?