Virtual Cross Connects V1

Virtual Cross Connect operations V1

Get Available Bandwidths

Get a list of available bandwidths for VXC creation

SecuritybasicAuth or bearerAuth

Request

query Parameters

filter[site_id]	string The `id` of the site you want to filter on
filter[cloud_provider]	string The cloud provider you want to filter on
filter[cloud_region]	string The cloud region you want to filter on
filter[local]	boolean Whether you want to see only local regions

Responses

200

Successful response

Response Schema: application/json

	Array of objects (VXCBandwidth)
	object (Metadata)

401

Authentication error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

get/networking/vxc_bandwidths

Request samples

Response samples

application/json

{"data": [{"site_id": "string",
"cloud_provider": "string",
"cloud_region": "string",
"local": true,
"bandwidths": [{"bandwidth_mbps": 0,
"currency": "string",
"amount": 0
}
],
"record_type": "string"
}
],
"meta": {"total_pages": 13,
"total_results": 13,
"page_number": 3,
"page_size": 1
}
}

Get all VXCs

Returns a list of all your networks

SecuritybasicAuth or bearerAuth

Request

query Parameters

filter[site_id]	number The site `id` to filter on
filter[network_id]	number The network `id` to filter on
page[number]	number Current page based on pagination settings.
page[size]	number Number of results to return per page based on pagination settings.

Responses

200

Successful response

Response Schema: application/json

	Array of objects (VXC)
	object (Metadata)

401

Authentication error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

get/networking/vxcs

Request samples

Response samples

application/json

{"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"
}
],
"meta": {"total_pages": 13,
"total_results": 13,
"page_number": 3,
"page_size": 1
}
}

Order a VXC

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

SecuritybasicAuth or bearerAuth

Request

Request Body schema: application/json

afi required	string The type of IP addressing you plan to utilize for the VXC. Currently only `IPv4` is supported
bandwidth_mbps required	number The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.
bgp_asn required	number The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx.
cloud_account_id required	string The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.
cloud_provider required	string The Virtual Private Cloud with which you would like to establish a cross connect. Options include “AWS”, “Azure”, or “Google”.
cloud_region required	string The region where your Virtual Private Cloud hosts are located. For a list of regions, please contact Telnyx Support.
network_id required	string The `id` of the network to comission the VXC on.
site_id required	string 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

Response Schema: application/json

object (VXC)

afi required	string The type of IP addressing you plan to utilize for the VXC
bandwidth_mbps required	number The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.
bgp_asn required	number The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx.
cloud_account_id required	string The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.
cloud_provider required	string The Virtual Private Cloud with which you would like to establish a cross connect. Options include “AWS”, “Azure”, or “Google”.
cloud_region required	string The region where your Virtual Private Cloud hosts are located. If you do not see your region on the list below, please contact Telnyx Support with the region you require, and Telnyx will add it to the list of options.
network_id required	string The `id` of the network to comission the VXC on.
site_id required	string The `id` of the site to comission the VXC on. You must already have added the site to your network.
user_id required	string The `id` of the owner of the VXC.
id required	number The `id` of the VXC
notes required	string Notes from Telnyx
primary_cid required	string The circuit id of the primary VXC link
primary_link_id required	string The `id` of the primary VXC link
primary_bgp_key required	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 required	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 required	boolean Whether the primary BGP route is being announced
primary_telnyx_ip required	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`
primary_virtual_link_created required	boolean Whether the primary virtual link has been created on the exchange
record_type required	string The type of record being returned. This will always be `vxc`.
secondary_link_id	string The `id` of the secondary VXC link
secondary_cid	string The circuit id of the secondary VXC link
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 required	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`
secondary_virtual_link_created	boolean Whether the secondary virtual link has been created on the exchange
order_status required	string Status of the VXC order

401

Authentication error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

422

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

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

post/networking/vxcs

Request samples

application/json

{"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

application/json

{"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"
}
}

Get a VXC

Retrieve details of a VXC

SecuritybasicAuth or bearerAuth

Request

path Parameters

required

string

The id of the VXC

Responses

200

Successful response

Response Schema: application/json

object (VXC)

afi required	string The type of IP addressing you plan to utilize for the VXC
bandwidth_mbps required	number The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.
bgp_asn required	number The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx.
cloud_account_id required	string The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.
cloud_provider required	string The Virtual Private Cloud with which you would like to establish a cross connect. Options include “AWS”, “Azure”, or “Google”.
cloud_region required	string The region where your Virtual Private Cloud hosts are located. If you do not see your region on the list below, please contact Telnyx Support with the region you require, and Telnyx will add it to the list of options.
network_id required	string The `id` of the network to comission the VXC on.
site_id required	string The `id` of the site to comission the VXC on. You must already have added the site to your network.
user_id required	string The `id` of the owner of the VXC.
id required	number The `id` of the VXC
notes required	string Notes from Telnyx
primary_cid required	string The circuit id of the primary VXC link
primary_link_id required	string The `id` of the primary VXC link
primary_bgp_key required	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 required	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 required	boolean Whether the primary BGP route is being announced
primary_telnyx_ip required	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`
primary_virtual_link_created required	boolean Whether the primary virtual link has been created on the exchange
record_type required	string The type of record being returned. This will always be `vxc`.
secondary_link_id	string The `id` of the secondary VXC link
secondary_cid	string The circuit id of the secondary VXC link
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 required	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`
secondary_virtual_link_created	boolean Whether the secondary virtual link has been created on the exchange
order_status required	string Status of the VXC order

401

Authentication error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

404

Resource not found

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

get/networking/vxcs/{id}

Request samples

Response samples

application/json

{"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"
}
}

Update VXC

Update the details of a VXC

SecuritybasicAuth or bearerAuth

Request

path Parameters

required

string

The id of the VXC

Request Body schema: application/json

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

Responses

200

Successful response

Response Schema: application/json

object (VXC)

afi required	string The type of IP addressing you plan to utilize for the VXC
bandwidth_mbps required	number The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.
bgp_asn required	number The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx.
cloud_account_id required	string The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.
cloud_provider required	string The Virtual Private Cloud with which you would like to establish a cross connect. Options include “AWS”, “Azure”, or “Google”.
cloud_region required	string The region where your Virtual Private Cloud hosts are located. If you do not see your region on the list below, please contact Telnyx Support with the region you require, and Telnyx will add it to the list of options.
network_id required	string The `id` of the network to comission the VXC on.
site_id required	string The `id` of the site to comission the VXC on. You must already have added the site to your network.
user_id required	string The `id` of the owner of the VXC.
id required	number The `id` of the VXC
notes required	string Notes from Telnyx
primary_cid required	string The circuit id of the primary VXC link
primary_link_id required	string The `id` of the primary VXC link
primary_bgp_key required	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 required	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 required	boolean Whether the primary BGP route is being announced
primary_telnyx_ip required	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`
primary_virtual_link_created required	boolean Whether the primary virtual link has been created on the exchange
record_type required	string The type of record being returned. This will always be `vxc`.
secondary_link_id	string The `id` of the secondary VXC link
secondary_cid	string The circuit id of the secondary VXC link
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 required	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`
secondary_virtual_link_created	boolean Whether the secondary virtual link has been created on the exchange
order_status required	string Status of the VXC order

401

Authentication error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

422

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

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

patch/networking/vxcs/{id}

Request samples

application/json

{"primary_cloud_ip": "string",
"primary_routing_announcement": true,
"secondary_cloud_ip": "string",
"secondary_routing_announcement": true
}

Response samples

application/json

{"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"
}
}

Delete a VXC

SecuritybasicAuth or bearerAuth

Request

path Parameters

required

string

The id of the VXC

Responses

200

Successful response

Response Schema: application/json

object (VXC)

afi required	string The type of IP addressing you plan to utilize for the VXC
bandwidth_mbps required	number The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.
bgp_asn required	number The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx.
cloud_account_id required	string The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.
cloud_provider required	string The Virtual Private Cloud with which you would like to establish a cross connect. Options include “AWS”, “Azure”, or “Google”.
cloud_region required	string The region where your Virtual Private Cloud hosts are located. If you do not see your region on the list below, please contact Telnyx Support with the region you require, and Telnyx will add it to the list of options.
network_id required	string The `id` of the network to comission the VXC on.
site_id required	string The `id` of the site to comission the VXC on. You must already have added the site to your network.
user_id required	string The `id` of the owner of the VXC.
id required	number The `id` of the VXC
notes required	string Notes from Telnyx
primary_cid required	string The circuit id of the primary VXC link
primary_link_id required	string The `id` of the primary VXC link
primary_bgp_key required	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 required	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 required	boolean Whether the primary BGP route is being announced
primary_telnyx_ip required	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`
primary_virtual_link_created required	boolean Whether the primary virtual link has been created on the exchange
record_type required	string The type of record being returned. This will always be `vxc`.
secondary_link_id	string The `id` of the secondary VXC link
secondary_cid	string The circuit id of the secondary VXC link
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 required	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`
secondary_virtual_link_created	boolean Whether the secondary virtual link has been created on the exchange
order_status required	string Status of the VXC order

401

Authentication error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

delete/networking/vxcs/{id}

Request samples

Response samples

application/json

{"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"
}
}

Delete a VXC Link

SecuritybasicAuth or bearerAuth

Request

path Parameters

vxc_id required	string The `id` of the VXC
link_id required	string The `id` of the VXC's Link

Responses

200

Successful response

Response Schema: application/json

object (VXC)

afi required	string The type of IP addressing you plan to utilize for the VXC
bandwidth_mbps required	number The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.
bgp_asn required	number The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx.
cloud_account_id required	string The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.
cloud_provider required	string The Virtual Private Cloud with which you would like to establish a cross connect. Options include “AWS”, “Azure”, or “Google”.
cloud_region required	string The region where your Virtual Private Cloud hosts are located. If you do not see your region on the list below, please contact Telnyx Support with the region you require, and Telnyx will add it to the list of options.
network_id required	string The `id` of the network to comission the VXC on.
site_id required	string The `id` of the site to comission the VXC on. You must already have added the site to your network.
user_id required	string The `id` of the owner of the VXC.
id required	number The `id` of the VXC
notes required	string Notes from Telnyx
primary_cid required	string The circuit id of the primary VXC link
primary_link_id required	string The `id` of the primary VXC link
primary_bgp_key required	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 required	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 required	boolean Whether the primary BGP route is being announced
primary_telnyx_ip required	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`
primary_virtual_link_created required	boolean Whether the primary virtual link has been created on the exchange
record_type required	string The type of record being returned. This will always be `vxc`.
secondary_link_id	string The `id` of the secondary VXC link
secondary_cid	string The circuit id of the secondary VXC link
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 required	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`
secondary_virtual_link_created	boolean Whether the secondary virtual link has been created on the exchange
order_status required	string Status of the VXC order

401

Authentication error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

delete/networking/vxcs/{vxc_id}/links/{link_id}

Request samples

Response samples

application/json

{"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"
}
}