List Virtual Cross Connect Cloud Coverage

GET 
/virtual_cross_connects_coverage

List Virtual Cross Connects Cloud Coverage.

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

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

filters[available_bandwidth][contains] integer
The available bandwidth to filter on.
Example: 50
filter[cloud_provider] string

Possible values: [aws, azure, gce]

The Telnyx region code

filter[cloud_provider_region] string

The cloud provider region code to filter on

filter[location.region] string

The region of associated location to filter on.

filter[location.site] string

The site of associated location to filter on.

filter[location.pop] string

The POP of associated location to filter on.

filter[location.code] string

The code of associated location to filter on.

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data object[]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "record_type": "virtual_cross_connects_coverage",
      "location": {
        "region": "AMER",
        "site": "ORD",
        "pop": "CH1",
        "code": "chicago-il",
        "name": "Chicago IL, US"
      },
      "cloud_provider": "aws",
      "cloud_provider_region": "us-east-1",
      "available_bandwidth": [
        50,
        100,
        200,
        500
      ]
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

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

Response samples

• 200
• default

---

{
  "data": [
    {
      "record_type": "virtual_cross_connects_coverage",
      "location": {
        "region": "AMER",
        "site": "ORD",
        "pop": "CH1",
        "code": "chicago-il",
        "name": "Chicago IL, US"
      },
      "cloud_provider": "aws",
      "cloud_provider_region": "us-east-1",
      "available_bandwidth": [
        50,
        100,
        200,
        500
      ]
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}