Sign in
Virtual Cross Connects

List Virtual Cross Connect Cloud Coverage

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

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.codestring

The code of associated location to filter on.

location.popstring

The POP of associated location to filter on.

location.regionstring

The region of associated location to filter on.

location.sitestring

The site 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.code": "silicon_valley-ca",
  "location.pop": "SV1",
  "location.region": "AMER",
  "location.site": "SJC"
}
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": [
    {
      "available_bandwidth": [
        50,
        100,
        200,
        500
      ],
      "cloud_provider": "aws",
      "cloud_provider_region": "us-east-1",
      "location": {
        "code": "chicago-il",
        "name": "Chicago IL, US",
        "pop": "CH1",
        "region": "AMER",
        "site": "ORD"
      },
      "record_type": "virtual_cross_connects_coverage"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Changes

Changed in 2 of the 61 revisions of this API.4

  • 1571b0380bd72See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status default

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379942See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status default

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog