List Virtual Cross Connect Cloud 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.
GET
/
virtual_cross_connects
/
coverage
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const virtualCrossConnectsCoverageListResponse of client.virtualCrossConnectsCoverage.list()) {
console.log(virtualCrossConnectsCoverageListResponse.available_bandwidth);
}import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
page = client.virtual_cross_connects_coverage.list()
page = page.data[0]
print(page.available_bandwidth)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.VirtualCrossConnectsCoverage.List(context.TODO(), telnyx.VirtualCrossConnectsCoverageListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.virtualcrossconnectscoverage.VirtualCrossConnectsCoverageListPage;
import com.telnyx.sdk.models.virtualcrossconnectscoverage.VirtualCrossConnectsCoverageListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
VirtualCrossConnectsCoverageListPage page = client.virtualCrossConnectsCoverage().list();
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
page = telnyx.virtual_cross_connects_coverage.list
puts(page)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$page = $client->virtualCrossConnectsCoverage->list(
filter: [
'cloudProvider' => 'aws',
'cloudProviderRegion' => 'us-east-1',
'locationCode' => 'silicon_valley-ca',
'locationPop' => 'SV1',
'locationRegion' => 'AMER',
'locationSite' => 'SJC',
],
filters: ['availableBandwidth' => 0],
pageNumber: 0,
pageSize: 0,
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx virtual-cross-connects-coverage list \
--api-key 'My API Key'curl --request GET \
--url https://api.telnyx.com/v2/virtual_cross_connects/coverage \
--header 'Authorization: Bearer <token>'{
"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": {}
}
]
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Consolidated filters parameter (deepObject style). Originally: filters[available_bandwidth][contains]
Show child attributes
Show child attributes
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]
Show child attributes
Show child attributes
Consolidated page parameter (deepObject style). Originally: page[number], page[size]
Show child attributes
Show child attributes
Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const virtualCrossConnectsCoverageListResponse of client.virtualCrossConnectsCoverage.list()) {
console.log(virtualCrossConnectsCoverageListResponse.available_bandwidth);
}import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
page = client.virtual_cross_connects_coverage.list()
page = page.data[0]
print(page.available_bandwidth)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.VirtualCrossConnectsCoverage.List(context.TODO(), telnyx.VirtualCrossConnectsCoverageListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.virtualcrossconnectscoverage.VirtualCrossConnectsCoverageListPage;
import com.telnyx.sdk.models.virtualcrossconnectscoverage.VirtualCrossConnectsCoverageListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
VirtualCrossConnectsCoverageListPage page = client.virtualCrossConnectsCoverage().list();
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
page = telnyx.virtual_cross_connects_coverage.list
puts(page)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$page = $client->virtualCrossConnectsCoverage->list(
filter: [
'cloudProvider' => 'aws',
'cloudProviderRegion' => 'us-east-1',
'locationCode' => 'silicon_valley-ca',
'locationPop' => 'SV1',
'locationRegion' => 'AMER',
'locationSite' => 'SJC',
],
filters: ['availableBandwidth' => 0],
pageNumber: 0,
pageSize: 0,
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx virtual-cross-connects-coverage list \
--api-key 'My API Key'curl --request GET \
--url https://api.telnyx.com/v2/virtual_cross_connects/coverage \
--header 'Authorization: Bearer <token>'{
"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": {}
}
]
}{
"errors": [
{
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"source": {
"pointer": "<string>",
"parameter": "<string>"
},
"meta": {}
}
]
}