All URIs are relative to https://api.ionos.com/cloudapi/v5
Method
HTTP request
Description
pccs_delete
Object pccs_delete(pcc_id, opts)
Delete a Private Cross-Connect
Delete a private cross-connect if no datacenters are joined to the given PCC
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.configure do|config|# Configure HTTP basic authorization: Basic Authentication config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: Token Authentication config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =Ionoscloud::PrivateCrossConnectApi.newpcc_id ='pcc_id_example'# String | The unique ID of the private cross-connectopts = { pretty: true,# Boolean | Controls whether response is pretty-printed (with indentation and new lines) depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}begin# Delete a Private Cross-Connect result = api_instance.pccs_delete(pcc_id, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling PrivateCrossConnectApi->pccs_delete: #{e}"end
Using the pccs_delete_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# Delete a Private Cross-Connect data, status_code, headers = api_instance.pccs_delete_with_http_info(pcc_id, opts)p status_code # => 2xxp headers # => { ... }p data # => ObjectrescueIonoscloud::ApiError=> eputs"Error when calling PrivateCrossConnectApi->pccs_delete_with_http_info: #{e}"end
Parameters
Return type
Object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
pccs_find_by_id
pccs_find_by_id(pcc_id, opts)
Retrieve a Private Cross-Connect
You can retrieve a private cross-connect by using the resource's ID. This value can be found in the response body when a private cross-connect is created or when you GET a list of private cross-connects.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.configure do|config|# Configure HTTP basic authorization: Basic Authentication config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: Token Authentication config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =Ionoscloud::PrivateCrossConnectApi.newpcc_id ='pcc_id_example'# String | The unique ID of the private cross-connectopts = { pretty: true,# Boolean | Controls whether response is pretty-printed (with indentation and new lines) depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}begin# Retrieve a Private Cross-Connect result = api_instance.pccs_find_by_id(pcc_id, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling PrivateCrossConnectApi->pccs_find_by_id: #{e}"end
Using the pccs_find_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
You can retrieve a complete list of private cross-connects provisioned under your account
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.configure do|config|# Configure HTTP basic authorization: Basic Authentication config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: Token Authentication config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =Ionoscloud::PrivateCrossConnectApi.newopts = { pretty: true,# Boolean | Controls whether response is pretty-printed (with indentation and new lines) depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}begin# List Private Cross-Connects result = api_instance.pccs_get(opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling PrivateCrossConnectApi->pccs_get: #{e}"end
Using the pccs_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
You can use update private cross-connect to re-name or update its description
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.configure do|config|# Configure HTTP basic authorization: Basic Authentication config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: Token Authentication config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =Ionoscloud::PrivateCrossConnectApi.newpcc_id ='pcc_id_example'# String | The unique ID of the private cross-connectpcc = Ionoscloud::PrivateCrossConnectProperties.new # PrivateCrossConnectProperties | Modified properties of private cross-connect
opts = { pretty: true,# Boolean | Controls whether response is pretty-printed (with indentation and new lines) depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}begin# Partially modify a private cross-connect result = api_instance.pccs_patch(pcc_id, pcc, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling PrivateCrossConnectApi->pccs_patch: #{e}"end
Using the pccs_patch_with_http_info variant
This returns an Array which contains the response data, status code and headers.
You can use this POST method to create a private cross-connect
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.configure do|config|# Configure HTTP basic authorization: Basic Authentication config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: Token Authentication config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =Ionoscloud::PrivateCrossConnectApi.newpcc = Ionoscloud::PrivateCrossConnect.new({properties: Ionoscloud::PrivateCrossConnectProperties.new}) # PrivateCrossConnect | Private Cross-Connect to be created
opts = { pretty: true,# Boolean | Controls whether response is pretty-printed (with indentation and new lines) depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
}begin# Create a Private Cross-Connect result = api_instance.pccs_post(pcc, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling PrivateCrossConnectApi->pccs_post: #{e}"end
Using the pccs_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.