# PrivateCrossConnectsApi ## PrivateCrossConnectsApi All URIs are relative to ** | Method | HTTP request | Description | | --------------------------------- | ------------------------ | --------------------------------------- | | [**pccsDelete**](#pccsdelete) | **DELETE** /pccs/{pccId} | Delete private Cross-Connects | | [**pccsFindById**](#pccsfindbyid) | **GET** /pccs/{pccId} | Retrieve private Cross-Connects | | [**pccsGet**](#pccsget) | **GET** /pccs | List private Cross-Connects | | [**pccsPatch**](#pccspatch) | **PATCH** /pccs/{pccId} | Partially modify private Cross-Connects | | [**pccsPost**](#pccspost) | **POST** /pccs | Create a Private Cross-Connect | ## **pccsDelete** > pccsDelete(pccId, pretty, depth, xContractNumber) Delete private Cross-Connects Remove the specified private Cross-Connect (only if not connected to any data centers). #### Parameters | Name | Type | Description | Notes | | ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **pccId** | **String** | The unique ID of the private Cross-Connect. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional] \[default to 0] | | **xContractNumber** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type null (empty response body) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the pccsDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use pccsDelete instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.PrivateCrossConnectsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); PrivateCrossConnectsApi apiInstance = new PrivateCrossConnectsApi(defaultClient); String pccId = "pccId_example"; // String | The unique ID of the private Cross-Connect. Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. try { apiInstance.pccsDeleteWithHttpInfo(pccId, pretty, depth, xContractNumber); } catch (ApiException e) { System.err.println("Exception when calling PrivateCrossConnectsApi#pccsDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ⚠️ **Note**: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults. For convenience, you can alternatively use a builder, which allows to omit optional parameters: ```java try { apiInstance.pccsDelete(pccId) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling PrivateCrossConnectsApi#pccsDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **pccsFindById** > PrivateCrossConnect pccsFindById(pccId, pretty, depth, xContractNumber) Retrieve private Cross-Connects Retrieve a private Cross-Connect by the resource ID. Cross-Connect ID is in the response body when the private Cross-Connect is created, and in the list of private Cross-Connects, returned by GET. #### Parameters | Name | Type | Description | Notes | | ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **pccId** | **String** | The unique ID of the private Cross-Connect. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional] \[default to 0] | | **xContractNumber** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type [**PrivateCrossConnect**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/privatecrossconnect) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the pccsFindByIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use pccsFindById instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.PrivateCrossConnectsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); PrivateCrossConnectsApi apiInstance = new PrivateCrossConnectsApi(defaultClient); String pccId = "pccId_example"; // String | The unique ID of the private Cross-Connect. Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. try { ApiResponse result = apiInstance.pccsFindByIdWithHttpInfo(pccId, pretty, depth, xContractNumber); System.out.println("Response: " + result.getData()); System.out.println("Status Code: " + result.getStatusCode()); System.out.println("Headers: " + result.getHeaders()); } catch (ApiException e) { System.err.println("Exception when calling PrivateCrossConnectsApi#pccsFindById"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ⚠️ **Note**: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults. For convenience, you can alternatively use a builder, which allows to omit optional parameters: ```java try { PrivateCrossConnect result = apiInstance.pccsFindById(pccId) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling PrivateCrossConnectsApi#pccsFindById"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **pccsGet** > PrivateCrossConnects pccsGet(pretty, depth, xContractNumber) List private Cross-Connects List all private Cross-Connects for your account. #### Parameters | Name | Type | Description | Notes | | ------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional] \[default to 0] | | **xContractNumber** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | | orderBy | String | Sorts the results alphanumerically in ascending order based on the specified property. | \[optional] | | maxResults | Integer | Limits the number of results returned. | \[optional] | | filters | Map\ | Limit results to those containing a matching value for a specific property. | \[optional] | #### Return type [**PrivateCrossConnects**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/privatecrossconnects) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the pccsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use pccsGet instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.PrivateCrossConnectsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); PrivateCrossConnectsApi apiInstance = new PrivateCrossConnectsApi(defaultClient); Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. String orderBy = "orderBy_example"; // String | Order by field Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return Map filters = new HashMap(); // Map | Filter results by field try { ApiResponse result = apiInstance.pccsGetWithHttpInfo(pretty, depth, xContractNumber, orderBy, maxResults, filters); System.out.println("Response: " + result.getData()); System.out.println("Status Code: " + result.getStatusCode()); System.out.println("Headers: " + result.getHeaders()); } catch (ApiException e) { System.err.println("Exception when calling PrivateCrossConnectsApi#pccsGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ⚠️ **Note**: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults. For convenience, you can alternatively use a builder, which allows to omit optional parameters: ```java try { PrivateCrossConnects result = apiInstance.pccsGet() .pretty(true) .depth(0) .xContractNumber(56) .orderBy("orderBy_example") .maxResults(5) .filters(filters) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling PrivateCrossConnectsApi#pccsGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **pccsPatch** > PrivateCrossConnect pccsPatch(pccId, pcc, pretty, depth, xContractNumber) Partially modify private Cross-Connects Update the properties of the specified private Cross-Connect. #### Parameters | Name | Type | Description | Notes | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **pccId** | **String** | The unique ID of the private Cross-Connect. | | | **pcc** | [**PrivateCrossConnectProperties**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/privatecrossconnectproperties) | The properties of the private Cross-Connect to be updated. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional] \[default to 0] | | **xContractNumber** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type [**PrivateCrossConnect**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/privatecrossconnect) #### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ⚠️ **Note**: the example bellow uses the pccsPatchWithHttpInfo which also returns the status code and the headers, if you don't need them you may use pccsPatch instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.PrivateCrossConnectsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); PrivateCrossConnectsApi apiInstance = new PrivateCrossConnectsApi(defaultClient); String pccId = "pccId_example"; // String | The unique ID of the private Cross-Connect. PrivateCrossConnectProperties pcc = new PrivateCrossConnectProperties(); // PrivateCrossConnectProperties | The properties of the private Cross-Connect to be updated. Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. try { ApiResponse result = apiInstance.pccsPatchWithHttpInfo(pccId, pcc, pretty, depth, xContractNumber); System.out.println("Response: " + result.getData()); System.out.println("Status Code: " + result.getStatusCode()); System.out.println("Headers: " + result.getHeaders()); } catch (ApiException e) { System.err.println("Exception when calling PrivateCrossConnectsApi#pccsPatch"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ⚠️ **Note**: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults. For convenience, you can alternatively use a builder, which allows to omit optional parameters: ```java try { PrivateCrossConnect result = apiInstance.pccsPatch(pccId, pcc) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling PrivateCrossConnectsApi#pccsPatch"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **pccsPost** > PrivateCrossConnect pccsPost(pcc, pretty, depth, xContractNumber) Create a Private Cross-Connect Creates a private Cross-Connect. #### Parameters | Name | Type | Description | Notes | | ------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **pcc** | [**PrivateCrossConnect**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/privatecrossconnect) | The private Cross-Connect to create. | | | **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | \[optional] \[default to true] | | **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/\[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on | \[optional] \[default to 0] | | **xContractNumber** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | \[optional] | #### Return type [**PrivateCrossConnect**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/privatecrossconnect) #### HTTP request headers * **Content-Type**: application/json * **Accept**: application/json ⚠️ **Note**: the example bellow uses the pccsPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use pccsPost instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.PrivateCrossConnectsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); PrivateCrossConnectsApi apiInstance = new PrivateCrossConnectsApi(defaultClient); properties = new PrivateCrossConnectProperties(); // PrivateCrossConnectProperties | pcc = new PrivateCrossConnect(PrivateCrossConnectProperties); // PrivateCrossConnect | The private Cross-Connect to create. Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. try { ApiResponse result = apiInstance.pccsPostWithHttpInfo(pcc, pretty, depth, xContractNumber); System.out.println("Response: " + result.getData()); System.out.println("Status Code: " + result.getStatusCode()); System.out.println("Headers: " + result.getHeaders()); } catch (ApiException e) { System.err.println("Exception when calling PrivateCrossConnectsApi#pccsPost"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ⚠️ **Note**: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults. For convenience, you can alternatively use a builder, which allows to omit optional parameters: ```java try { PrivateCrossConnect result = apiInstance.pccsPost(pcc) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling PrivateCrossConnectsApi#pccsPost"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ```