Skip to main content

Order a VXC

POST 
/networking/vxcs

Use the Get Available Bandwidths API to find all available bandwidths and their corresponding prices.

Request

Body

    afi stringrequired

    The type of IP addressing you plan to utilize for the VXC. Currently only IPv4 is supported

    bandwidth_mbps numberrequired

    The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.

    bgp_asn numberrequired

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

    cloud_account_id stringrequired

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

    cloud_provider stringrequired

    The Virtual Private Cloud with which you would like to establish a cross connect. Options include “AWS”, “Azure”, or “Google”.

    cloud_region stringrequired

    The region where your Virtual Private Cloud hosts are located. For a list of regions, please contact Telnyx Support.

    network_id stringrequired

    The id of the network to comission the VXC on.

    site_id stringrequired

    The id of the site to comission the VXC on. You must already have added the site to your network.

    primary_bgp_key string

    If null, the value will either be auto-generated by Telnyx (for AWS and Azure) or by your VPC (for Google Cloud). If you have AWS and Azure, and you want to specify your own value, you will also need to specify a value for primary_cloud_ip and primary_telnyx_ip

    primary_cloud_ip string

    If null, the value will either be auto-generated by Telnyx (for AWS and Azure) or by your VPC (for Google Cloud). If you have AWS and Azure, and you want to specify your own value, you will also need to specify a value for primary_telnyx_ip and primary_bgp_key

    primary_routing_announcement boolean

    Whether the primary BGP route is being announced

    primary_telnyx_ip string

    If null, the value will either be auto-generated by Telnyx (for AWS and Azure) or by your VPC (for Google Cloud). If you have AWS and Azure, and you want to specify your own value, you will also need to specify a value for primary_cloud_ip and primary_bgp_key

    secondary_bgp_key string

    If null, the value will either be auto-generated by Telnyx (for AWS and Azure) or by your VPC (for Google Cloud). This field should only be included in the POST body if you desire a redundant link. If you have AWS and Azure, and you want to specify your own value, you will also need to specify a value for secondary_cloud_ip and secondary_telnyx_ip

    secondary_cloud_account_id string

    For Google Cloud only. The pairing key for your redundant Virtual Private Cloud. This field should only be included in the POST body if you desire a redundant link. If no redundant link is desired, omit this parameter from the POST. If you include this field, you must also include secondary_telnyx_ip, secondary_cloud_ip, and secondary_bgp_key

    secondary_cloud_ip string

    If null, the value will either be auto-generated by Telnyx (for AWS and Azure) or by your VPC (for Google Cloud). This field should only be included in the POST body if you desire a redundant link. If you have AWS and Azure, and you want to specify your own value, you will also need to specify a value for secondary_telnyx_ip and secondary_bgp_key

    secondary_routing_announcement boolean

    Whether the secondary BGP route is being announced

    secondary_telnyx_ip string

    If null, the value will either be auto-generated by Telnyx (for AWS and Azure) or by your VPC (for Google Cloud). This field should only be included in the POST body if you desire a redundant link. If you have AWS and Azure, and you want to specify your own value, you will also need to specify a value for secondary_cloud_ip and secondary_bgp_key

Responses

200: Successful response

401: Authentication error

403: Authorization error

422: Invalid parameters supplied in request. See HTTP response body for details.

Request samples


curl -L 'https://api.telnyx.com/networking/vxcs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"afi": "string",
"bandwidth_mbps": 0,
"bgp_asn": 0,
"cloud_account_id": "string",
"cloud_provider": "string",
"cloud_region": "string",
"network_id": "string",
"site_id": "string",
"primary_bgp_key": "string",
"primary_cloud_ip": "string",
"primary_routing_announcement": true,
"primary_telnyx_ip": "string",
"secondary_bgp_key": "string",
"secondary_cloud_account_id": "string",
"secondary_cloud_ip": "string",
"secondary_routing_announcement": true,
"secondary_telnyx_ip": "string"
}'

Response samples


{
"data": {
"afi": "string",
"bandwidth_mbps": 0,
"bgp_asn": 0,
"cloud_account_id": "string",
"cloud_provider": "string",
"cloud_region": "string",
"network_id": "string",
"site_id": "string",
"user_id": "string",
"id": 0,
"notes": "string",
"primary_cid": "string",
"primary_link_id": "string",
"primary_bgp_key": "string",
"primary_cloud_ip": "string",
"primary_routing_announcement": true,
"primary_telnyx_ip": "string",
"primary_virtual_link_created": true,
"record_type": "string",
"secondary_link_id": "string",
"secondary_cid": "string",
"secondary_bgp_key": "string",
"secondary_cloud_account_id": "string",
"secondary_cloud_ip": "string",
"secondary_routing_announcement": true,
"secondary_telnyx_ip": "string",
"secondary_virtual_link_created": true,
"order_status": "string"
}
}