Virtual Cross Connects

List Virtual Cross Connect Cloud Coverage

Changed on

List Virtual Cross Connects Cloud Coverage.<br /><br />This endpoint shows which cloud regions are available for the location_code your Virtual Cross Connect will be provisioned in.

get/virtual_cross_connects_coverage

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/virtual_cross_connects_coverage
  • Auth: HTTP bearer

Query parameters

Consolidated filters parameter (deepObject style). Originally: filters[available_bandwidth][contains]

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

The Virtual Private Cloud provider.

cloud_provider_regionstring

The region of specific cloud provider.

location.regionstring

The region of associated location to filter on.

location.sitestring

The site of associated location to filter on.

location.popstring

The POP of associated location to filter on.

location.codestring

The code of associated location to filter on.

Consolidated filter parameter (deepObject style). Originally: filter[cloud_provider], filter[cloud_provider_region], filter[location.region], filter[location.site], filter[location.pop], filter[location.code]

{
  "cloud_provider": "aws",
  "cloud_provider_region": "us-east-1",
  "location.region": "AMER",
  "location.site": "SJC",
  "location.pop": "SV1",
  "location.code": "silicon_valley-ca"
}
numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Response

Successful response

Example response

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

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

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

    • info

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

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status