FirewallRulesApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
|---|---|---|
DELETE /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} | Delete firewall rules | |
GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} | Retrieve firewall rules | |
GET /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules | List firewall rules | |
PATCH /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} | Partially modify firewall rules | |
POST /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules | Create firewall rules | |
PUT /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId} | Modify firewall rules |
datacenters_servers_nics_firewallrules_delete(datacenter_id, server_id, nic_id, firewallrule_id, opts)
Delete firewall rules
Delete the specified firewall rule.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.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'
end
api_instance = Ionoscloud::FirewallRulesApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
server_id = 'server_id_example' # String | The unique ID of the server.
nic_id = 'nic_id_example' # String | The unique ID of the NIC.
firewallrule_id = 'firewallrule_id_example' # String | The unique ID of the firewall rule.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # 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
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Delete firewall rules
api_instance.datacenters_servers_nics_firewallrules_delete(datacenter_id, server_id, nic_id, firewallrule_id, opts)
rescue Ionoscloud::ApiError => e
puts "Error when calling FirewallRulesApi->datacenters_servers_nics_firewallrules_delete: #{e}"
end
This returns an Array which contains the response data (
nil in this case), status code and headers.<Array(nil, Integer, Hash)> datacenters_servers_nics_firewallrules_delete_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, opts)
begin
# Delete firewall rules
data, status_code, headers = api_instance.datacenters_servers_nics_firewallrules_delete_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Ionoscloud::ApiError => e
puts "Error when calling FirewallRulesApi->datacenters_servers_nics_firewallrules_delete_with_http_info: #{e}"
end
Name | Type | Description | Notes |
|---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
server_id | String | The unique ID of the server. | |
nic_id | String | The unique ID of the NIC. | |
firewallrule_id | String | The unique ID of the firewall rule. | |
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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
nil (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
datacenters_servers_nics_firewallrules_find_by_id(datacenter_id, server_id, nic_id, firewallrule_id, opts)
Retrieve firewall rules
Retrieve the properties of the specified firewall rule.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.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'
end
api_instance = Ionoscloud::FirewallRulesApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
server_id = 'server_id_example' # String | The unique ID of the server.
nic_id = 'nic_id_example' # String | The unique ID of the NIC.
firewallrule_id = 'firewallrule_id_example' # String | The unique ID of the firewall rule.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # 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
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Retrieve firewall rules
result = api_instance.datacenters_servers_nics_firewallrules_find_by_id(datacenter_id, server_id, nic_id, firewallrule_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling FirewallRulesApi->datacenters_servers_nics_firewallrules_find_by_id: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_servers_nics_firewallrules_find_by_id_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, opts)
begin
# Retrieve firewall rules
data, status_code, headers = api_instance.datacenters_servers_nics_firewallrules_find_by_id_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <FirewallRule>
rescue Ionoscloud::ApiError => e
puts "Error when calling FirewallRulesApi->datacenters_servers_nics_firewallrules_find_by_id_with_http_info: #{e}"
end
Name | Type | Description | Notes |
|---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
server_id | String | The unique ID of the server. | |
nic_id | String | The unique ID of the NIC. | |
firewallrule_id | String | The unique ID of the firewall rule. | |
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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
datacenters_servers_nics_firewallrules_get(datacenter_id, server_id, nic_id, opts)
List firewall rules
List all firewall rules for the specified NIC.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.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'
end
api_instance = Ionoscloud::FirewallRulesApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
server_id = 'server_id_example' # String | The unique ID of the server.
nic_id = 'nic_id_example' # String | The unique ID of the NIC.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # 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
x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).
limit: 56 # Integer | The maximum number of elements to return (use together with offset for pagination).
}
begin
# List firewall rules
result = api_instance.datacenters_servers_nics_firewallrules_get(datacenter_id, server_id, nic_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling FirewallRulesApi->datacenters_servers_nics_firewallrules_get: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_servers_nics_firewallrules_get_with_http_info(datacenter_id, server_id, nic_id, opts)
begin
# List firewall rules
data, status_code, headers = api_instance.datacenters_servers_nics_firewallrules_get_with_http_info(datacenter_id, server_id, nic_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <FirewallRules>
rescue Ionoscloud::ApiError => e
puts "Error when calling FirewallRulesApi->datacenters_servers_nics_firewallrules_get_with_http_info: #{e}"
end
Name | Type | Description | Notes |
|---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
server_id | String | The unique ID of the server. | |
nic_id | String | The unique ID of the NIC. | |
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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
offset | Integer | The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination). | [optional][default to 0] |
limit | Integer | The maximum number of elements to return (use together with offset for pagination). | [optional][default to 1000] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
datacenters_servers_nics_firewallrules_patch(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
Partially modify firewall rules
Update the properties of the specified firewall rule.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.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'
end
api_instance = Ionoscloud::FirewallRulesApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
server_id = 'server_id_example' # String | The unique ID of the server.
nic_id = 'nic_id_example' # String | The unique ID of the NIC.
firewallrule_id = 'firewallrule_id_example' # String | The unique ID of the firewall rule.
firewallrule = Ionoscloud::FirewallruleProperties.new({protocol: 'TCP'}) # FirewallruleProperties | The properties of the firewall rule to be updated.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # 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
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Partially modify firewall rules
result = api_instance.datacenters_servers_nics_firewallrules_patch(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling FirewallRulesApi->datacenters_servers_nics_firewallrules_patch: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_servers_nics_firewallrules_patch_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
begin
# Partially modify firewall rules
data, status_code, headers = api_instance.datacenters_servers_nics_firewallrules_patch_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <FirewallRule>
rescue Ionoscloud::ApiError => e
puts "Error when calling FirewallRulesApi->datacenters_servers_nics_firewallrules_patch_with_http_info: #{e}"
end
Name | Type | Description | Notes |
|---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
server_id | String | The unique ID of the server. | |
nic_id | String | The unique ID of the NIC. | |
firewallrule_id | String | The unique ID of the firewall rule. | |
firewallrule | The properties of the firewall rule 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
datacenters_servers_nics_firewallrules_post(datacenter_id, server_id, nic_id, firewallrule, opts)
Create firewall rules
Create a firewall rule for the specified NIC.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.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'
end
api_instance = Ionoscloud::FirewallRulesApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
server_id = 'server_id_example' # String | The unique ID of the server.
nic_id = 'nic_id_example' # String | The unique ID of the NIC.
firewallrule = Ionoscloud::FirewallRule.new({properties: Ionoscloud::FirewallruleProperties.new({protocol: 'TCP'})}) # FirewallRule | The firewall rule to create.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # 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
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Create firewall rules
result = api_instance.datacenters_servers_nics_firewallrules_post(datacenter_id, server_id, nic_id, firewallrule, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling FirewallRulesApi->datacenters_servers_nics_firewallrules_post: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_servers_nics_firewallrules_post_with_http_info(datacenter_id, server_id, nic_id, firewallrule, opts)
begin
# Create firewall rules
data, status_code, headers = api_instance.datacenters_servers_nics_firewallrules_post_with_http_info(datacenter_id, server_id, nic_id, firewallrule, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <FirewallRule>
rescue Ionoscloud::ApiError => e
puts "Error when calling FirewallRulesApi->datacenters_servers_nics_firewallrules_post_with_http_info: #{e}"
end
Name | Type | Description | Notes |
|---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
server_id | String | The unique ID of the server. | |
nic_id | String | The unique ID of the NIC. | |
firewallrule | The firewall rule 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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
datacenters_servers_nics_firewallrules_put(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
Modify firewall rules
Modify the properties of the specified firewall rule.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.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'
end
api_instance = Ionoscloud::FirewallRulesApi.new
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
server_id = 'server_id_example' # String | The unique ID of the server.
nic_id = 'nic_id_example' # String | The unique ID of the NIC.
firewallrule_id = 'firewallrule_id_example' # String | The unique ID of the firewall rule.
firewallrule = Ionoscloud::FirewallRule.new({properties: Ionoscloud::FirewallruleProperties.new({protocol: 'TCP'})}) # FirewallRule | The modified firewall rule.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # 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
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Modify firewall rules
result = api_instance.datacenters_servers_nics_firewallrules_put(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling FirewallRulesApi->datacenters_servers_nics_firewallrules_put: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_servers_nics_firewallrules_put_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
begin
# Modify firewall rules
data, status_code, headers = api_instance.datacenters_servers_nics_firewallrules_put_with_http_info(datacenter_id, server_id, nic_id, firewallrule_id, firewallrule, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <FirewallRule>
rescue Ionoscloud::ApiError => e
puts "Error when calling FirewallRulesApi->datacenters_servers_nics_firewallrules_put_with_http_info: #{e}"
end
Name | Type | Description | Notes |
|---|---|---|---|
datacenter_id | String | The unique ID of the data center. | |
server_id | String | The unique ID of the server. | |
nic_id | String | The unique ID of the NIC. | |
firewallrule_id | String | The unique ID of the firewall rule. | |
firewallrule | The modified firewall rule. | | |
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] |
x_contract_number | Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
Last modified 1yr ago