Retrieve a connection

Retrieves the high-level details of an existing connection. To retrieve specific authentication information, use the endpoint for the specific connection type.

GET /connections/{id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

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

const connection = await client.connections.retrieve('id');

console.log(connection.data);

200

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "ip_connection",
    "active": true,
    "anchorsite_override": "Latency",
    "connection_name": "string",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "webhook_event_url": "https://example.com",
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_api_version": "1",
    "outbound_voice_profile_id": "1293384261075731499"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

IP Connection ID

Response

200

application/json

Successful response with details about a connection.

data · Connection · object

Show child attributes

Example:

{
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "ip_connection",
  "active": true,
  "anchorsite_override": "Latency",
  "connection_name": "string",
  "created_at": "2018-02-02T22:25:27.521Z",
  "updated_at": "2018-02-02T22:25:27.521Z",
  "webhook_event_url": "https://example.com",
  "webhook_event_failover_url": "https://failover.example.com",
  "webhook_api_version": "1",
  "outbound_voice_profile_id": "1293384261075731499"
}