Retrieve a Virtual Cross Connect
GET/virtual_cross_connects/:id
Retrieve a Virtual Cross Connect.
Request
Path Parameters
Identifies the resource.
Responses
200: Successful response
- application/json
- Schema
- Example (from schema)
Schema
data
object
Identifies the resource.
Identifies the type of the resource.
ISO 8601 formatted date-time indicating when the resource was created.
ISO 8601 formatted date-time indicating when the resource was updated.
The id of the network associated with the interface.
A user specified name for the interface.
Possible values: [created
, provisioning
, provisioned
, deleting
]
The current status of the interface deployment.
Possible values: [aws
, azure
, gce
]
The Virtual Private Cloud with which you would like to establish a cross connect.
The region where your Virtual Private Cloud hosts are located.
The available regions can be found using the /virtual_cross_connect_regions endpoint.
The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx.
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.
Indicates whether the primary circuit is enabled. Setting this to false
will disable the circuit.
The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.
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.
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.
The authentication key for BGP peer configuration.
Indicates whether the secondary circuit is enabled. Setting this to false
will disable the circuit.
The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.
This attribute is only necessary for GCE.
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.
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.
The authentication key for BGP peer configuration.
The region the interface should be deployed to.
Whether the primary BGP route is being announced.
Whether the secondary BGP route is being announced.
region
object
Region code of the interface.
Region name of the interface.
Identifies the type of the resource.
{
"data": {
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": true,
"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_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_cloud_account_id": "",
"secondary_telnyx_ip": "169.254.0.3",
"secondary_cloud_ip": "169.254.0.4",
"secondary_bgp_key": "ge1lONeK9RcA83uuWaw9DvZy",
"region_code": "ashburn-va",
"primary_routing_announcement": false,
"secondary_routing_announcement": false,
"region": {
"code": "ashburn-va",
"name": "Ashburn",
"record_type": "region"
}
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}