Get a VXC

GET 
/networking/vxcs/:id

Retrieve details of a VXC

Request

Path Parameters

id stringrequired

The id of the VXC

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

afi stringrequired

The type of IP addressing you plan to utilize for the VXC

bandwidth_mbps numberrequired

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

bgp_asn numberrequired

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

cloud_account_id stringrequired

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

cloud_provider stringrequired

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

cloud_region stringrequired

The region where your Virtual Private Cloud hosts are located. 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 stringrequired

The id of the network to comission the VXC on.

site_id stringrequired

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

user_id stringrequired

The id of the owner of the VXC.

id numberrequired

The id of the VXC

notes stringrequired

Notes from Telnyx

primary_cid stringrequired

The circuit id of the primary VXC link

primary_link_id stringrequired

The id of the primary VXC link

primary_bgp_key stringrequired

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 stringrequired

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 booleanrequired

Whether the primary BGP route is being announced

primary_telnyx_ip stringrequired

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 booleanrequired

Whether the primary virtual link has been created on the exchange

record_type stringrequired

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 stringrequired

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 stringrequired

Status of the VXC order

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

401: Authentication error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

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.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

403: Authorization error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

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.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

404: Resource not found

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

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.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/networking/vxcs/:id' \
-H 'Accept: application/json'

Response samples

• 200
• 401
• 403
• 404

---

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

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}