Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const virtualCrossConnect = await client.virtualCrossConnects.retrieve( '6a09cdc3-8948-47f0-aa62-74ac943d6c58', ); console.log(virtualCrossConnect.data);

{ "data": { "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "cloud_provider": "aws", "cloud_provider_region": "us-east-1", "bgp_asn": 1234, "primary_cloud_account_id": "123456789012", "region_code": "ashburn-va", "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "record_type": "virtual_cross_connect", "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z", "name": "test interface", "status": "provisioned", "bandwidth_mbps": 50, "primary_enabled": true, "primary_telnyx_ip": "169.254.0.1", "primary_cloud_ip": "169.254.0.2", "primary_bgp_key": "yFV4wEPtPVPfDUGLWiyQzwga", "secondary_enabled": true, "secondary_cloud_account_id": "", "secondary_telnyx_ip": "169.254.0.3", "secondary_cloud_ip": "169.254.0.4", "secondary_bgp_key": "ge1lONeK9RcA83uuWaw9DvZy", "primary_routing_announcement": false, "secondary_routing_announcement": false, "region": { "code": "ashburn-va", "name": "Ashburn", "record_type": "region" } } }

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Identifies the resource.

Example:

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

Response

Successful response

data

VirtualCrossConnectPatch · object

Show child attributes

data.network_id

string<uuid>

required

The id of the network associated with the interface.

Example:

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

data.cloud_provider

enum<string>

required

The Virtual Private Cloud with which you would like to establish a cross connect.

Available options:

aws,

azure,

gce

Example:

"aws"

data.cloud_provider_region

string

required

The region where your Virtual Private Cloud hosts are located. The available regions can be found using the /virtual_cross_connect_regions endpoint.

Example:

"us-east-1"

data.bgp_asn

number

required

The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx.

Example:

1234

data.primary_cloud_account_id

string

required

The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.

Example:

"123456789012"

data.region_code

string

required

The region the interface should be deployed to. The region interface is deployed to.

Example:

"ashburn-va"

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:

"virtual_cross_connect"

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.name

string

A user specified name for the interface.

Example:

"test interface"

data.status

enum<string>

The current status of the interface deployment.

Available options:

created,

provisioning,

provisioned,

deleting

Example:

"provisioned"

data.bandwidth_mbps

number

The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect. The available bandwidths can be found using the /virtual_cross_connect_regions endpoint.

Example:

50

data.primary_enabled

boolean

Indicates whether the primary circuit is enabled. Setting this to false will disable the circuit. Indicates whether the primary circuit is enabled. Setting this to false will disable the circuit.

Example:

true

data.primary_telnyx_ip

string

The IP address assigned to the Telnyx side of the Virtual Cross Connect. If none is provided, one will be generated for you. This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted.

Example:

"169.254.0.1"

data.primary_cloud_ip

string

The IP address assigned for your side of the Virtual Cross Connect. If none is provided, one will be generated for you. This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. The IP address assigned for your side of the Virtual Cross Connect. If none is provided, one will be generated for you. This value can not be patched once the VXC has bene provisioned.

Example:

"169.254.0.2"

data.primary_bgp_key

string

The authentication key for BGP peer configuration.

Example:

"yFV4wEPtPVPfDUGLWiyQzwga"

data.secondary_enabled

boolean

Indicates whether the secondary circuit is enabled. Setting this to false will disable the circuit. Indicates whether the secondary circuit is enabled. Setting this to false will disable the circuit.

Example:

true

data.secondary_cloud_account_id

string

The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider. This attribute is only necessary for GCE.

Example:

""

data.secondary_telnyx_ip

string

Example:

"169.254.0.3"

data.secondary_cloud_ip

string

Example:

"169.254.0.4"

data.secondary_bgp_key

string

The authentication key for BGP peer configuration.

Example:

"ge1lONeK9RcA83uuWaw9DvZy"

data.primary_routing_announcement

boolean

Whether the primary BGP route is being announced.

Example:

false

data.secondary_routing_announcement

boolean

Whether the secondary BGP route is being announced.

Example:

false

data.region

object

Show child attributes

data.region.code

string

Region code of the interface.

Example:

"ashburn-va"

data.region.name

string

Region name of the interface.

Example:

"Ashburn"

data.region.record_type

string

Identifies the type of the resource.

Example:

"region"

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