Sign in
Virtual Cross Connects

Create a Virtual Cross Connect

Create a new Virtual Cross Connect.<br /><br />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.

post/virtual_cross_connects

Request body

idstring uuid

Identifies the resource.

record_typestring

Identifies the type of the resource.

created_atstring

ISO 8601 formatted date-time indicating when the resource was created.

updated_atstring

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

network_idstring uuid

The id of the network associated with the interface.

namestring

A user specified name for the interface.

status'created' | 'provisioning' | 'provisioned' | 'deleting'

The current status of the interface deployment.

cloud_provider'aws' | 'azure' | 'gce'

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

cloud_provider_regionstring

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

bgp_asnnumber

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

bandwidth_mbpsnumber

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

primary_enabledboolean

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

primary_cloud_account_idstring

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

primary_telnyx_ipstring

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

primary_cloud_ipstring

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

primary_bgp_keystring

The authentication key for BGP peer configuration.

secondary_enabledboolean

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

secondary_cloud_account_idstring

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

secondary_telnyx_ipstring

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

secondary_cloud_ipstring

The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />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_keystring

The authentication key for BGP peer configuration.

region_codestring required

The region the interface should be deployed to.

Example request

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

Response

Successful response

Example response

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

Changes

Changed in 4 of the 47 revisions of this API.43842

  • 8a8c40f458c51191See the full diff
    • ▲

      the data response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ●

      removed the optional property data/bandwidth_mbps from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/bgp_asn from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/cloud_provider from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/cloud_provider_region from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/created_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/name from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/network_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/primary_bgp_key from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/primary_cloud_account_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/primary_cloud_ip from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/primary_enabled from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/primary_routing_announcement from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/primary_telnyx_ip from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/record_type from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/region from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/region_code from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/status from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/updated_at from the response with the 200 status

      response-optional-property-removed

    • ○

      added VirtualCrossConnectCreate VirtualCrossConnectPatch RegionOut to the data response property allOf list for the response status 200

      response-property-all-of-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 50870cc05614120See the full diff
    • ▲

      the data response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ○

      added the optional property data/bandwidth_mbps to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/bgp_asn to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/cloud_provider to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/cloud_provider_region to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/created_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/network_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/primary_bgp_key to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/primary_cloud_account_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/primary_cloud_ip to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/primary_enabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/primary_routing_announcement to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/primary_telnyx_ip to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/record_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/region to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/region_code to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/status to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/updated_at to the response with the 200 status

      response-optional-property-added

    • ○

      removed VirtualCrossConnectCreate VirtualCrossConnectPatch RegionOut from the data response property allOf list for the response status 200

      response-property-all-of-removed

  • a144ff96b4ac1191See the full diff
    • ▲

      the data response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ●

      removed the optional property data/bandwidth_mbps from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/bgp_asn from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/cloud_provider from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/cloud_provider_region from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/created_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/name from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/network_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/primary_bgp_key from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/primary_cloud_account_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/primary_cloud_ip from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/primary_enabled from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/primary_routing_announcement from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/primary_telnyx_ip from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/record_type from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/region from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/region_code from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/status from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/updated_at from the response with the 200 status

      response-optional-property-removed

    • ○

      added VirtualCrossConnectCreate VirtualCrossConnectPatch RegionOut to the data response property allOf list for the response status 200

      response-property-all-of-added

  • 30cb1ddce91b120See the full diff
    • ▲

      the data response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ○

      added the optional property data/bandwidth_mbps to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/bgp_asn to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/cloud_provider to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/cloud_provider_region to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/created_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/network_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/primary_bgp_key to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/primary_cloud_account_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/primary_cloud_ip to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/primary_enabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/primary_routing_announcement to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/primary_telnyx_ip to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/record_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/region to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/region_code to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/status to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/updated_at to the response with the 200 status

      response-optional-property-added

    • ○

      removed VirtualCrossConnectCreate VirtualCrossConnectPatch RegionOut from the data response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog