Virtual Cross Connects API

Virtual Cross Connect operations API

List all Virtual Cross Connect Cloud Regions

List all Virtual Cross Connects Cloud Regions.

This endpoint shows which cloud regions are available for the region_code your Virtual Cross Connect will be provisioned in.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[region_code]
string

The Telnyx region code

Example: filter[region_code]=ashburn-va
filter[cloud_provider]
string

The Telnyx region code

Enum: "aws" "azure" "gce"
Example: filter[cloud_provider]=aws
Responses
200

Successful response

Response Schema: application/json
Array of objects (VirtualCrossConnectRegion)
object (PaginationMeta)
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/virtual_cross_connect_regions
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "record_type": "virtual_cross_connect_region",
      • "updated_at": "2018-02-02T22:25:27.521Z",
      • "bandwidth_mbps": [
        • 50,
        • 100,
        • 200,
        • 500
        ],
      • "cloud_provider": "aws",
      • "cloud_region": "us-east-1",
      • "region_code": "ashburn-va"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Retrieve a Virtual Cross Connect Cloud Regions
Retrieve a Virtual Cross Connect Cloud Regions.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
Successful response


Response Schema: application/json
object (VirtualCrossConnectRegion) 
 
created_at
string
ISO 8601 formatted date-time indicating when the resource was created.


 
id
string <uuid> 
Identifies the resource.


 
record_type
string
Identifies the type of the resource.


 
updated_at
string
ISO 8601 formatted date-time indicating when the resource was updated.


 
bandwidth_mbps
Array of numbers
The available throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.


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


 Enum: "aws" "azure" "gce"  
cloud_region
string
The region where your Virtual Private Cloud hosts are located.


 
region_code
string
The region the interface is deployed to.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/virtual_cross_connect_regions/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "virtual_cross_connect_region",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "bandwidth_mbps": [
      • 50,
      • 100,
      • 200,
      • 500
      ],
    • "cloud_provider": "aws",
    • "cloud_region": "us-east-1",
    • "region_code": "ashburn-va"
    }
}
List all Virtual Cross Connects
List all Virtual Cross Connects.


SecuritybearerAuth 
Request 
query Parameters
page[number]
integer  >= 1 
 Default:  1
The page number to load


 
page[size]
integer  [ 1 .. 250 ] 
 Default:  20
The size of the page


 
filter[network_id]
string
The associated network id to filter on.


 
 Example:  filter[network_id]=6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
Successful response


Response Schema: application/json
Array of objects (VirtualCrossConnectCombined) 
 
object (PaginationMeta) 
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/virtual_cross_connects
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "record_type": "virtual_cross_connect",
      • "updated_at": "2018-02-02T22:25:27.521Z",
      • "name": "test interface",
      • "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "status": "provisioned",
      • "bandwidth_mbps": 50,
      • "bgp_asn": 1234,
      • "cloud_provider": "aws",
      • "cloud_region": "us-east-1",
      • "primary_bgp_key": "yFV4wEPtPVPfDUGLWiyQzwga",
      • "primary_cloud_account_id": "123456789012",
      • "primary_cloud_ip": "169.254.0.2",
      • "primary_enabled": true,
      • "primary_telnyx_ip": "169.254.0.1",
      • "secondary_bgp_key": "ge1lONeK9RcA83uuWaw9DvZy",
      • "secondary_cloud_account_id": "",
      • "secondary_cloud_ip": "169.254.0.4",
      • "secondary_enabled": true,
      • "secondary_telnyx_ip": "169.254.0.3",
      • "region_code": "ashburn-va",
      • "primary_routing_announcement": false,
      • "secondary_routing_announcement": false,
      • "region": {
        • "code": "ashburn-va",
        • "name": "Ashburn",
        • "record_type": "region"
        }
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Create a Virtual Cross Connect
Create a new Virtual Cross Connect.

For AWS and GCE, you have the option of creating the primary connection first and the secondary connection later. You also have the option of disabling the primary and/or secondary connections at any time and later re-enabling them. With Azure, you do not have this option. Azure requires both the primary and secondary connections to be created at the same time and they can not be independantly disabled.


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
name
string
A user specified name for the interface.


 
network_id
required
string <uuid> 
The id of the network associated with the interface.


 
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.


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


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


 Enum: "aws" "azure" "gce"  
cloud_region
required
string
The region where your Virtual Private Cloud hosts are located.

The available regions can be found using the /virtual_cross_connect_regions endpoint.


 
primary_bgp_key
string
The authentication key for BGP peer configuration.


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


 
primary_cloud_ip
string <ipv4> 
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.


 
primary_telnyx_ip
string <ipv4> 
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.


 
secondary_bgp_key
string
The authentication key for BGP peer configuration.


 
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.


 
secondary_cloud_ip
string <ipv4> 
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.


 
secondary_telnyx_ip
string <ipv4> 
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.


 
region_code
required
string
The region the interface should be deployed to.


 
Responses 
200
Successful response


Response Schema: application/json
object (VirtualCrossConnectCombined) 
 
created_at
string
ISO 8601 formatted date-time indicating when the resource was created.


 
id
string <uuid> 
Identifies the resource.


 
record_type
string
Identifies the type of the resource.


 
updated_at
string
ISO 8601 formatted date-time indicating when the resource was updated.


 
name
string
A user specified name for the interface.


 
network_id
required
string <uuid> 
The id of the network associated with the interface.


 
status
string (InterfaceStatus) 
The current status of the interface deployment.


 Enum: "created" "provisioning" "provisioned" "deleting"  
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.


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


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


 Enum: "aws" "azure" "gce"  
cloud_region
required
string
The region where your Virtual Private Cloud hosts are located.

The available regions can be found using the /virtual_cross_connect_regions endpoint.


 
primary_bgp_key
string
The authentication key for BGP peer configuration.


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


 
primary_cloud_ip
string <ipv4> 
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.


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


 
primary_telnyx_ip
string <ipv4> 
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.


 
secondary_bgp_key
string
The authentication key for BGP peer configuration.


 
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.


 
secondary_cloud_ip
string <ipv4> 
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.


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


 
secondary_telnyx_ip
string <ipv4> 
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.


 
region_code
required
string
The region the interface should be deployed to.


 
primary_routing_announcement
boolean
Whether the primary BGP route is being announced.


 
secondary_routing_announcement
boolean
Whether the secondary BGP route is being announced.


 
object
 
422
Unprocessable entity. Check the 'detail' field in response for details.


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/virtual_cross_connects
Request samples 
application/json
{
  • "name": "test interface",
  • "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  • "bandwidth_mbps": 50,
  • "bgp_asn": 1234,
  • "cloud_provider": "aws",
  • "cloud_region": "us-east-1",
  • "primary_bgp_key": "yFV4wEPtPVPfDUGLWiyQzwga",
  • "primary_cloud_account_id": "123456789012",
  • "primary_cloud_ip": "169.254.0.2",
  • "primary_telnyx_ip": "169.254.0.1",
  • "secondary_bgp_key": "ge1lONeK9RcA83uuWaw9DvZy",
  • "secondary_cloud_account_id": "",
  • "secondary_cloud_ip": "169.254.0.4",
  • "secondary_telnyx_ip": "169.254.0.3",
  • "region_code": "ashburn-va"
}
Response samples 
application/json
{
  • "data": {
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "virtual_cross_connect",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "name": "test interface",
    • "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "status": "provisioned",
    • "bandwidth_mbps": 50,
    • "bgp_asn": 1234,
    • "cloud_provider": "aws",
    • "cloud_region": "us-east-1",
    • "primary_bgp_key": "yFV4wEPtPVPfDUGLWiyQzwga",
    • "primary_cloud_account_id": "123456789012",
    • "primary_cloud_ip": "169.254.0.2",
    • "primary_enabled": true,
    • "primary_telnyx_ip": "169.254.0.1",
    • "secondary_bgp_key": "ge1lONeK9RcA83uuWaw9DvZy",
    • "secondary_cloud_account_id": "",
    • "secondary_cloud_ip": "169.254.0.4",
    • "secondary_enabled": true,
    • "secondary_telnyx_ip": "169.254.0.3",
    • "region_code": "ashburn-va",
    • "primary_routing_announcement": false,
    • "secondary_routing_announcement": false,
    • "region": {
      • "code": "ashburn-va",
      • "name": "Ashburn",
      • "record_type": "region"
      }
    }
}
Delete a Virtual Cross Connect
Delete a Virtual Cross Connect.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
Successful response


Response Schema: application/json
object (VirtualCrossConnectCombined) 
 
created_at
string
ISO 8601 formatted date-time indicating when the resource was created.


 
id
string <uuid> 
Identifies the resource.


 
record_type
string
Identifies the type of the resource.


 
updated_at
string
ISO 8601 formatted date-time indicating when the resource was updated.


 
name
string
A user specified name for the interface.


 
network_id
required
string <uuid> 
The id of the network associated with the interface.


 
status
string (InterfaceStatus) 
The current status of the interface deployment.


 Enum: "created" "provisioning" "provisioned" "deleting"  
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.


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


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


 Enum: "aws" "azure" "gce"  
cloud_region
required
string
The region where your Virtual Private Cloud hosts are located.

The available regions can be found using the /virtual_cross_connect_regions endpoint.


 
primary_bgp_key
string
The authentication key for BGP peer configuration.


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


 
primary_cloud_ip
string <ipv4> 
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.


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


 
primary_telnyx_ip
string <ipv4> 
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.


 
secondary_bgp_key
string
The authentication key for BGP peer configuration.


 
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.


 
secondary_cloud_ip
string <ipv4> 
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.


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


 
secondary_telnyx_ip
string <ipv4> 
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.


 
region_code
required
string
The region the interface should be deployed to.


 
primary_routing_announcement
boolean
Whether the primary BGP route is being announced.


 
secondary_routing_announcement
boolean
Whether the secondary BGP route is being announced.


 
object
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
delete/virtual_cross_connects/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "virtual_cross_connect",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "name": "test interface",
    • "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "status": "provisioned",
    • "bandwidth_mbps": 50,
    • "bgp_asn": 1234,
    • "cloud_provider": "aws",
    • "cloud_region": "us-east-1",
    • "primary_bgp_key": "yFV4wEPtPVPfDUGLWiyQzwga",
    • "primary_cloud_account_id": "123456789012",
    • "primary_cloud_ip": "169.254.0.2",
    • "primary_enabled": true,
    • "primary_telnyx_ip": "169.254.0.1",
    • "secondary_bgp_key": "ge1lONeK9RcA83uuWaw9DvZy",
    • "secondary_cloud_account_id": "",
    • "secondary_cloud_ip": "169.254.0.4",
    • "secondary_enabled": true,
    • "secondary_telnyx_ip": "169.254.0.3",
    • "region_code": "ashburn-va",
    • "primary_routing_announcement": false,
    • "secondary_routing_announcement": false,
    • "region": {
      • "code": "ashburn-va",
      • "name": "Ashburn",
      • "record_type": "region"
      }
    }
}
Retrieve a Virtual Cross Connect
Retrieve a Virtual Cross Connect.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
Successful response


Response Schema: application/json
object (VirtualCrossConnectCombined) 
 
created_at
string
ISO 8601 formatted date-time indicating when the resource was created.


 
id
string <uuid> 
Identifies the resource.


 
record_type
string
Identifies the type of the resource.


 
updated_at
string
ISO 8601 formatted date-time indicating when the resource was updated.


 
name
string
A user specified name for the interface.


 
network_id
required
string <uuid> 
The id of the network associated with the interface.


 
status
string (InterfaceStatus) 
The current status of the interface deployment.


 Enum: "created" "provisioning" "provisioned" "deleting"  
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.


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


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


 Enum: "aws" "azure" "gce"  
cloud_region
required
string
The region where your Virtual Private Cloud hosts are located.

The available regions can be found using the /virtual_cross_connect_regions endpoint.


 
primary_bgp_key
string
The authentication key for BGP peer configuration.


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


 
primary_cloud_ip
string <ipv4> 
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.


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


 
primary_telnyx_ip
string <ipv4> 
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.


 
secondary_bgp_key
string
The authentication key for BGP peer configuration.


 
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.


 
secondary_cloud_ip
string <ipv4> 
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.


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


 
secondary_telnyx_ip
string <ipv4> 
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.


 
region_code
required
string
The region the interface should be deployed to.


 
primary_routing_announcement
boolean
Whether the primary BGP route is being announced.


 
secondary_routing_announcement
boolean
Whether the secondary BGP route is being announced.


 
object
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/virtual_cross_connects/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "virtual_cross_connect",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "name": "test interface",
    • "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "status": "provisioned",
    • "bandwidth_mbps": 50,
    • "bgp_asn": 1234,
    • "cloud_provider": "aws",
    • "cloud_region": "us-east-1",
    • "primary_bgp_key": "yFV4wEPtPVPfDUGLWiyQzwga",
    • "primary_cloud_account_id": "123456789012",
    • "primary_cloud_ip": "169.254.0.2",
    • "primary_enabled": true,
    • "primary_telnyx_ip": "169.254.0.1",
    • "secondary_bgp_key": "ge1lONeK9RcA83uuWaw9DvZy",
    • "secondary_cloud_account_id": "",
    • "secondary_cloud_ip": "169.254.0.4",
    • "secondary_enabled": true,
    • "secondary_telnyx_ip": "169.254.0.3",
    • "region_code": "ashburn-va",
    • "primary_routing_announcement": false,
    • "secondary_routing_announcement": false,
    • "region": {
      • "code": "ashburn-va",
      • "name": "Ashburn",
      • "record_type": "region"
      }
    }
}
Update the Virtual Cross Connect
Update the Virtual Cross Connect.

Cloud IPs can only be patched during the created state, as GCE will only inform you of your generated IP once the pending connection requested has been accepted. Once the Virtual Cross Connect has moved to provisioning, the IPs can no longer be patched.

Once the Virtual Cross Connect has moved to provisioned and you are ready to enable routing, you can toggle the routing announcements to true.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Request Body schema: application/json
required
primary_cloud_ip
string <ipv4> 
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.


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


 
primary_routing_announcement
boolean
Whether the primary BGP route is being announced.


 
secondary_cloud_ip
string <ipv4> 
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.


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


 
secondary_routing_announcement
boolean
Whether the secondary BGP route is being announced.


 
Responses 
200
Successful response


Response Schema: application/json
object (VirtualCrossConnectCombined) 
 
created_at
string
ISO 8601 formatted date-time indicating when the resource was created.


 
id
string <uuid> 
Identifies the resource.


 
record_type
string
Identifies the type of the resource.


 
updated_at
string
ISO 8601 formatted date-time indicating when the resource was updated.


 
name
string
A user specified name for the interface.


 
network_id
required
string <uuid> 
The id of the network associated with the interface.


 
status
string (InterfaceStatus) 
The current status of the interface deployment.


 Enum: "created" "provisioning" "provisioned" "deleting"  
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.


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


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


 Enum: "aws" "azure" "gce"  
cloud_region
required
string
The region where your Virtual Private Cloud hosts are located.

The available regions can be found using the /virtual_cross_connect_regions endpoint.


 
primary_bgp_key
string
The authentication key for BGP peer configuration.


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


 
primary_cloud_ip
string <ipv4> 
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.


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


 
primary_telnyx_ip
string <ipv4> 
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.


 
secondary_bgp_key
string
The authentication key for BGP peer configuration.


 
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.


 
secondary_cloud_ip
string <ipv4> 
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.


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


 
secondary_telnyx_ip
string <ipv4> 
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.


 
region_code
required
string
The region the interface should be deployed to.


 
primary_routing_announcement
boolean
Whether the primary BGP route is being announced.


 
secondary_routing_announcement
boolean
Whether the secondary BGP route is being announced.


 
object
 
422
Unprocessable entity. Check the 'detail' field in response for details.


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
patch/virtual_cross_connects/{id}
Request samples 
application/json
{
  • "primary_cloud_ip": "169.254.0.2",
  • "primary_enabled": true,
  • "primary_routing_announcement": false,
  • "secondary_cloud_ip": "169.254.0.4",
  • "secondary_enabled": true,
  • "secondary_routing_announcement": false
}
Response samples 
application/json
{
  • "data": {
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "virtual_cross_connect",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "name": "test interface",
    • "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "status": "provisioned",
    • "bandwidth_mbps": 50,
    • "bgp_asn": 1234,
    • "cloud_provider": "aws",
    • "cloud_region": "us-east-1",
    • "primary_bgp_key": "yFV4wEPtPVPfDUGLWiyQzwga",
    • "primary_cloud_account_id": "123456789012",
    • "primary_cloud_ip": "169.254.0.2",
    • "primary_enabled": true,
    • "primary_telnyx_ip": "169.254.0.1",
    • "secondary_bgp_key": "ge1lONeK9RcA83uuWaw9DvZy",
    • "secondary_cloud_account_id": "",
    • "secondary_cloud_ip": "169.254.0.4",
    • "secondary_enabled": true,
    • "secondary_telnyx_ip": "169.254.0.3",
    • "region_code": "ashburn-va",
    • "primary_routing_announcement": false,
    • "secondary_routing_announcement": false,
    • "region": {
      • "code": "ashburn-va",
      • "name": "Ashburn",
      • "record_type": "region"
      }
    }
}
Provision a Virtual Cross Connect
Provision a new Virtual Cross Connect.

This endpoint is only necessary for GCE cloud regions. Once you have patched your Cloud IPs, you must POST this request to trigger the provision.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
202
Successful response


Response Schema: application/json
object (VirtualCrossConnectCombined) 
 
created_at
string
ISO 8601 formatted date-time indicating when the resource was created.


 
id
string <uuid> 
Identifies the resource.


 
record_type
string
Identifies the type of the resource.


 
updated_at
string
ISO 8601 formatted date-time indicating when the resource was updated.


 
name
string
A user specified name for the interface.


 
network_id
required
string <uuid> 
The id of the network associated with the interface.


 
status
string (InterfaceStatus) 
The current status of the interface deployment.


 Enum: "created" "provisioning" "provisioned" "deleting"  
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.


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


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


 Enum: "aws" "azure" "gce"  
cloud_region
required
string
The region where your Virtual Private Cloud hosts are located.

The available regions can be found using the /virtual_cross_connect_regions endpoint.


 
primary_bgp_key
string
The authentication key for BGP peer configuration.


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


 
primary_cloud_ip
string <ipv4> 
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.


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


 
primary_telnyx_ip
string <ipv4> 
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.


 
secondary_bgp_key
string
The authentication key for BGP peer configuration.


 
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.


 
secondary_cloud_ip
string <ipv4> 
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.


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


 
secondary_telnyx_ip
string <ipv4> 
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.


 
region_code
required
string
The region the interface should be deployed to.


 
primary_routing_announcement
boolean
Whether the primary BGP route is being announced.


 
secondary_routing_announcement
boolean
Whether the secondary BGP route is being announced.


 
object
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/virtual_cross_connects/{id}/actions/provision
Request samples 
Response samples 
application/json
{
  • "data": {
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "virtual_cross_connect",
    • "updated_at": "2018-02-02T22:25:27.521Z",
    • "name": "test interface",
    • "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "status": "provisioned",
    • "bandwidth_mbps": 50,
    • "bgp_asn": 1234,
    • "cloud_provider": "aws",
    • "cloud_region": "us-east-1",
    • "primary_bgp_key": "yFV4wEPtPVPfDUGLWiyQzwga",
    • "primary_cloud_account_id": "123456789012",
    • "primary_cloud_ip": "169.254.0.2",
    • "primary_enabled": true,
    • "primary_telnyx_ip": "169.254.0.1",
    • "secondary_bgp_key": "ge1lONeK9RcA83uuWaw9DvZy",
    • "secondary_cloud_account_id": "",
    • "secondary_cloud_ip": "169.254.0.4",
    • "secondary_enabled": true,
    • "secondary_telnyx_ip": "169.254.0.3",
    • "region_code": "ashburn-va",
    • "primary_routing_announcement": false,
    • "secondary_routing_announcement": false,
    • "region": {
      • "code": "ashburn-va",
      • "name": "Ashburn",
      • "record_type": "region"
      }
    }
}