Skip to main content

List all Virtual Cross Connects

GET 
/virtual_cross_connects

List all Virtual Cross Connects.

Request ​

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    filter[network_id] string

    The associated network id to filter on.

Responses ​

200: Successful response

Schema

    data object[]

    meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    object[]

  • Array [

    • code stringrequired
    title stringrequired
    detail string

    source

    object

    pointer string

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta

    object

    property name* any

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/virtual_cross_connects' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "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_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_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"
      }
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}