VXC API

The API resource is /v2/network_agents_gateway/vxc. The following parameters are required for all cloud providers.

Parameter	Value
`customer_name`	Human readable identifier for the customer or connection; something meaningful to you.
`network_id`	UUID of the Network, the user’s virtual routing and forwarding (VRF) domain, that the VXC attaches to. Required on create.
`type`	`single` for a single connection or `redundant` for a redundant pair.
`csp`	Cloud service provider: `AWS`, `GCP`, or `AZU`.
`region`	Cloud provider region, e.g. `us-east-1`. Use the coverage API to find available regions.
`location`	Telnyx PoP location name, e.g. `Ashburn VA, US`. Resolved from the coverage API response.
`speed`	Connection speed: `50M`, `100M`, `200M`, `500M`, or `1G`.

The following parameters are cloud provider specific:

Parameter	AWS	GCP	AZU	Description
`csp_account`	Required	Optional	Optional	AWS account ID; not needed for GCP/AZU.
`cross_connect`	Required	Optional	Optional	P2P BGP peering CIDR(s). AWS uses `/30`; GCP uses `/29`. GCP/AZU CIDRs may be set on create or via PATCH after provisioning.
`primary_pairing_key`	—	Required	—	GCP VLAN attachment pairing key. Format: `<uuid>/<region>/<n>`.
`secondary_pairing_key`	—	Required (redundant)	—	GCP secondary pairing key, redundant connections only.
`primary_service_key`	—	—	Required	Azure ExpressRoute circuit service key.
`secondary_service_key`	—	—	Required (redundant)	Azure secondary service key, redundant connections only.
`bgp_asn`	Optional	Optional	Optional	BGP ASN (0–65535). Defaults to CSP default if omitted.
`bgp_key_primary`	Optional	Optional	Optional	MD5 BGP authentication key for primary connection. Omit for no authentication.
`bgp_key_secondary`	Optional	Optional	Optional	MD5 BGP authentication key for secondary connection (redundant only).

Cross-connect CIDRs

AWS: /30 subnet required on create — e.g. {"primary": "169.254.0.0/30"}. Add secondary for redundant.
GCP: /29 subnet — e.g. {"primary": "169.254.2.0/29", "secondary": "169.254.2.8/29"}. Optional on create; can be set via PATCH. GCP takes the first usable IP, Telnyx takes the second.
AZU: /30 subnet. Optional on create; can be set via PATCH.

PATCH fields

All fields are optional; omit to leave unchanged.

Field	Description
`cross_connect`	Set or update P2P CIDRs (`{"primary": "..."}`, add `secondary` for redundant). GCP requires `/29`; AZU requires `/30`.
`bgp_key_primary`	Update primary BGP MD5 auth key.
`bgp_key_secondary`	Update secondary BGP MD5 auth key.
`bgp_enabled`	`true` = enable routing (routes advertised). `false` = disable routing (BGP stays up, no routes).
`private_ips`	Customer VPC IPs to add static NAT entries for.

Polling status

After a create or update, poll GET /v2/network_agents_gateway/vxc/{vxc_id} to track provisioning status. The agent reports pending while work is in progress, then created on success or failed on error.

Listing VXCs

request

GET /v2/network_agents_gateway/vxc?filter[network_id]=<uuid> HTTP/1.1
Host: api.telnyx.com
Authorization: Bearer ***

Supports filter[network_id], filter[customer_name], page[number], page[size].

Coverage

request

GET /v2/network_agents_gateway/vxc/coverage?filter[cloud_provider]=gcp HTTP/1.1
Host: api.telnyx.com
Authorization: Bearer ***

Returns available PoP locations per provider (aws, gcp, azu). Each entry includes region, site, pop, name, and code. Supported filters: filter[cloud_provider], filter[location.pop], filter[location.code], page[number], page[size]. Note: filter[cloud_provider_region] is not currently supported.

Guides

Virtual Cross Connects API

For AI Agents

Cross-connect CIDRs

PATCH fields

Polling status

Listing VXCs

Coverage

​Cross-connect CIDRs

​PATCH fields

​Polling status

​Listing VXCs

​Coverage

Cross-connect CIDRs

PATCH fields

Polling status

Listing VXCs

Coverage