VirtualCrossConnectsApi

All URIs are relative to https://api.telnyx.com/v2

Method	HTTP request	Description
createVirtualCrossConnect	POST /virtual_cross_connects	Create a Virtual Cross Connect
deleteVirtualCrossConnect	DELETE /virtual_cross_connects/{id}	Delete a Virtual Cross Connect
getVirtualCrossConnect	GET /virtual_cross_connects/{id}	Retrieve a Virtual Cross Connect
getVirtualCrossConnectRegion	GET /virtual_cross_connect_regions/{id}	Retrieve a Virtual Cross Connect Cloud Regions
listVirtualCrossConnectRegions	GET /virtual_cross_connect_regions	List all Virtual Cross Connect Cloud Regions
listVirtualCrossConnects	GET /virtual_cross_connects	List all Virtual Cross Connects
provisionVirtualCrossConnect	POST /virtual_cross_connects/{id}/actions/provision	Provision a Virtual Cross Connect
updateVirtualCrossConnect	PATCH /virtual_cross_connects/{id}	Update the Virtual Cross Connect

createVirtualCrossConnect

CreateVirtualCrossConnect200Response createVirtualCrossConnect(virtualCrossConnectCreate)

Create a Virtual Cross Connect

Create a new Virtual Cross Connect.

For AWS and GCE, you have the option of creating the primary connection first and the secondary connection later. You also have the option of disabling the primary and/or secondary connections at any time and later re-enabling them. With Azure, you do not have this option. Azure requires both the primary and secondary connections to be created at the same time and they can not be independantly disabled.

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VirtualCrossConnectsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        VirtualCrossConnectsApi apiInstance = new VirtualCrossConnectsApi(defaultClient);
        VirtualCrossConnectCreate virtualCrossConnectCreate = new VirtualCrossConnectCreate(); // VirtualCrossConnectCreate | 
        try {
            CreateVirtualCrossConnect200Response result = apiInstance.createVirtualCrossConnect(virtualCrossConnectCreate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualCrossConnectsApi#createVirtualCrossConnect");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
virtualCrossConnectCreate	VirtualCrossConnectCreate

Return type

CreateVirtualCrossConnect200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
422	Unprocessable entity. Check the 'detail' field in response for details.	-
0	Unexpected error	-

deleteVirtualCrossConnect

CreateVirtualCrossConnect200Response deleteVirtualCrossConnect(id)

Delete a Virtual Cross Connect

Delete a Virtual Cross Connect.

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VirtualCrossConnectsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        VirtualCrossConnectsApi apiInstance = new VirtualCrossConnectsApi(defaultClient);
        UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
        try {
            CreateVirtualCrossConnect200Response result = apiInstance.deleteVirtualCrossConnect(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualCrossConnectsApi#deleteVirtualCrossConnect");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID	Identifies the resource.

Return type

CreateVirtualCrossConnect200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

getVirtualCrossConnect

CreateVirtualCrossConnect200Response getVirtualCrossConnect(id)

Retrieve a Virtual Cross Connect

Retrieve a Virtual Cross Connect.

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VirtualCrossConnectsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        VirtualCrossConnectsApi apiInstance = new VirtualCrossConnectsApi(defaultClient);
        UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
        try {
            CreateVirtualCrossConnect200Response result = apiInstance.getVirtualCrossConnect(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualCrossConnectsApi#getVirtualCrossConnect");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID	Identifies the resource.

Return type

CreateVirtualCrossConnect200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

getVirtualCrossConnectRegion

GetVirtualCrossConnectRegion200Response getVirtualCrossConnectRegion(id)

Retrieve a Virtual Cross Connect Cloud Regions

Retrieve a Virtual Cross Connect Cloud Regions.

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VirtualCrossConnectsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        VirtualCrossConnectsApi apiInstance = new VirtualCrossConnectsApi(defaultClient);
        UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
        try {
            GetVirtualCrossConnectRegion200Response result = apiInstance.getVirtualCrossConnectRegion(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualCrossConnectsApi#getVirtualCrossConnectRegion");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID	Identifies the resource.

Return type

GetVirtualCrossConnectRegion200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

listVirtualCrossConnectRegions

ListVirtualCrossConnectRegions200Response listVirtualCrossConnectRegions(pageNumber, pageSize, filterRegionCode, filterCloudProvider)

List all Virtual Cross Connect Cloud Regions

List all Virtual Cross Connects Cloud Regions.

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

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VirtualCrossConnectsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        VirtualCrossConnectsApi apiInstance = new VirtualCrossConnectsApi(defaultClient);
        Integer pageNumber = 1; // Integer | The page number to load
        Integer pageSize = 20; // Integer | The size of the page
        String filterRegionCode = "ashburn-va"; // String | The Telnyx region code
        String filterCloudProvider = "aws"; // String | The Telnyx region code
        try {
            ListVirtualCrossConnectRegions200Response result = apiInstance.listVirtualCrossConnectRegions(pageNumber, pageSize, filterRegionCode, filterCloudProvider);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualCrossConnectsApi#listVirtualCrossConnectRegions");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
pageNumber	Integer	The page number to load	[optional] [default to 1]
pageSize	Integer	The size of the page	[optional] [default to 20]
filterRegionCode	String	The Telnyx region code	[optional]
filterCloudProvider	String	The Telnyx region code	[optional] [enum: aws, azure, gce]

Return type

ListVirtualCrossConnectRegions200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

listVirtualCrossConnects

ListVirtualCrossConnects200Response listVirtualCrossConnects(pageNumber, pageSize, filterNetworkId)

List all Virtual Cross Connects

List all Virtual Cross Connects.

Example

// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VirtualCrossConnectsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        VirtualCrossConnectsApi apiInstance = new VirtualCrossConnectsApi(defaultClient);
        Integer pageNumber = 1; // Integer | The page number to load
        Integer pageSize = 20; // Integer | The size of the page
        String filterNetworkId = "6a09cdc3-8948-47f0-aa62-74ac943d6c58"; // String | The associated network id to filter on.
        try {
            ListVirtualCrossConnects200Response result = apiInstance.listVirtualCrossConnects(pageNumber, pageSize, filterNetworkId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualCrossConnectsApi#listVirtualCrossConnects");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
pageNumber	Integer	The page number to load	[optional] [default to 1]
pageSize	Integer	The size of the page	[optional] [default to 20]
filterNetworkId	String	The associated network id to filter on.	[optional]

Return type

ListVirtualCrossConnects200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Unexpected error	-

provisionVirtualCrossConnect

CreateVirtualCrossConnect200Response provisionVirtualCrossConnect(id)

Provision a Virtual Cross Connect

Provision a new Virtual Cross Connect.

This endpoint is only necessary for GCE cloud regions. Once you have patched your Cloud IPs, you must POST this request to trigger the provision.

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VirtualCrossConnectsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        VirtualCrossConnectsApi apiInstance = new VirtualCrossConnectsApi(defaultClient);
        UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
        try {
            CreateVirtualCrossConnect200Response result = apiInstance.provisionVirtualCrossConnect(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualCrossConnectsApi#provisionVirtualCrossConnect");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID	Identifies the resource.

Return type

CreateVirtualCrossConnect200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Successful response	-
0	Unexpected error	-

updateVirtualCrossConnect

CreateVirtualCrossConnect200Response updateVirtualCrossConnect(id, virtualCrossConnectPatch)

Update the Virtual Cross Connect

Update the Virtual Cross Connect.

Cloud IPs can only be patched during the created state, as GCE will only inform you of your generated IP once the pending connection requested has been accepted. Once the Virtual Cross Connect has moved to provisioning, the IPs can no longer be patched.

Once the Virtual Cross Connect has moved to provisioned and you are ready to enable routing, you can toggle the routing announcements to true.

Example

import java.util.UUID;
// Import classes:
import com.telnyx.sdk.ApiClient;
import com.telnyx.sdk.ApiException;
import com.telnyx.sdk.Configuration;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.VirtualCrossConnectsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        VirtualCrossConnectsApi apiInstance = new VirtualCrossConnectsApi(defaultClient);
        UUID id = UUID.fromString("6a09cdc3-8948-47f0-aa62-74ac943d6c58"); // UUID | Identifies the resource.
        VirtualCrossConnectPatch virtualCrossConnectPatch = new VirtualCrossConnectPatch(); // VirtualCrossConnectPatch | 
        try {
            CreateVirtualCrossConnect200Response result = apiInstance.updateVirtualCrossConnect(id, virtualCrossConnectPatch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VirtualCrossConnectsApi#updateVirtualCrossConnect");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	UUID	Identifies the resource.
virtualCrossConnectPatch	VirtualCrossConnectPatch

Return type

CreateVirtualCrossConnect200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
422	Unprocessable entity. Check the 'detail' field in response for details.	-
0	Unexpected error	-

Files

VirtualCrossConnectsApi.md

Latest commit

History

VirtualCrossConnectsApi.md

File metadata and controls

VirtualCrossConnectsApi

createVirtualCrossConnect

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteVirtualCrossConnect

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getVirtualCrossConnect

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getVirtualCrossConnectRegion

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listVirtualCrossConnectRegions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listVirtualCrossConnects

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

provisionVirtualCrossConnect

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateVirtualCrossConnect

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details