diff --git a/README.md b/README.md
index b8e834a..00ac029 100644
--- a/README.md
+++ b/README.md
@@ -96,15 +96,15 @@ Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CustomerApi* | [**retrieve_customer**](docs/CustomerApi.md#retrieve_customer) | **GET** /v1/customer | Get customer info
*CustomerApi* | [**retrieve_payment_method**](docs/CustomerApi.md#retrieve_payment_method) | **GET** /v1/customer/payment-method | List current payment method
-*FirewallsApi* | [**assign_instance_firewall**](docs/FirewallsApi.md#assign_instance_firewall) | **POST** /v1/firewalls/{firewallId}/instances/{instanceId} | Add instance to a Firewall
-*FirewallsApi* | [**create_firewall**](docs/FirewallsApi.md#create_firewall) | **POST** /v1/firewalls | Create a new firewall
-*FirewallsApi* | [**delete_firewall**](docs/FirewallsApi.md#delete_firewall) | **DELETE** /v1/firewalls/{firewallId} | Delete existing Firewall by id
-*FirewallsApi* | [**patch_firewall**](docs/FirewallsApi.md#patch_firewall) | **PATCH** /v1/firewalls/{firewallId} | Update a Firewall by id
+*FirewallsApi* | [**assign_instance_firewall**](docs/FirewallsApi.md#assign_instance_firewall) | **POST** /v1/firewalls/{firewallId}/instances/{instanceId} | Add instance to a firewall
+*FirewallsApi* | [**create_firewall**](docs/FirewallsApi.md#create_firewall) | **POST** /v1/firewalls | Create a new firewall definition
+*FirewallsApi* | [**delete_firewall**](docs/FirewallsApi.md#delete_firewall) | **DELETE** /v1/firewalls/{firewallId} | Delete existing firewall by id
+*FirewallsApi* | [**patch_firewall**](docs/FirewallsApi.md#patch_firewall) | **PATCH** /v1/firewalls/{firewallId} | Update a firewall by id
*FirewallsApi* | [**put_firewall**](docs/FirewallsApi.md#put_firewall) | **PUT** /v1/firewalls/{firewallId} | Update specific firewall rules
*FirewallsApi* | [**retrieve_firewall**](docs/FirewallsApi.md#retrieve_firewall) | **GET** /v1/firewalls/{firewallId} | Get specific firewall by its id
-*FirewallsApi* | [**retrieve_firewall_list**](docs/FirewallsApi.md#retrieve_firewall_list) | **GET** /v1/firewalls | List firewalls
+*FirewallsApi* | [**retrieve_firewall_list**](docs/FirewallsApi.md#retrieve_firewall_list) | **GET** /v1/firewalls | List all firewalls
*FirewallsApi* | [**set_default_firewall**](docs/FirewallsApi.md#set_default_firewall) | **PUT** /v1/firewalls/{firewallId}/default | Set specific firewall to be default
-*FirewallsApi* | [**unassign_instance_firewall**](docs/FirewallsApi.md#unassign_instance_firewall) | **DELETE** /v1/firewalls/{firewallId}/instances/{instanceId} | Remove instance from a Firewall
+*FirewallsApi* | [**unassign_instance_firewall**](docs/FirewallsApi.md#unassign_instance_firewall) | **DELETE** /v1/firewalls/{firewallId}/instances/{instanceId} | Remove instance from a firewall
*FirewallsAuditsApi* | [**retrieve_firewall_audits_list**](docs/FirewallsAuditsApi.md#retrieve_firewall_audits_list) | **GET** /v1/firewalls/audits | List history about your Firewalls (audit)
*ImagesApi* | [**create_custom_image**](docs/ImagesApi.md#create_custom_image) | **POST** /v1/compute/images | Provide a custom image
*ImagesApi* | [**delete_image**](docs/ImagesApi.md#delete_image) | **DELETE** /v1/compute/images/{imageId} | Delete an uploaded custom image by its id
diff --git a/docs/AssignInstanceFirewallResponseLinks.md b/docs/AssignInstanceFirewallResponseLinks.md
index 0698b75..17028cd 100644
--- a/docs/AssignInstanceFirewallResponseLinks.md
+++ b/docs/AssignInstanceFirewallResponseLinks.md
@@ -6,7 +6,7 @@ Links for easy navigation.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_self** | **str** | Link to current resource. |
-**firewall** | **str** | Link to related Firewall. |
+**firewall** | **str** | Link to related firewall. |
**instance** | **str** | Link to assigned instance. |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
diff --git a/docs/CreateFirewallRequest.md b/docs/CreateFirewallRequest.md
index f94c73d..2de04aa 100644
--- a/docs/CreateFirewallRequest.md
+++ b/docs/CreateFirewallRequest.md
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the firewall. |
-**status** | **str** | Status of the firewall. |
+**status** | **str** | The status of the firewall determines whether the rules are active or not. |
**description** | **str** | The description of the firewall. | [optional]
**rules** | [**RulesRequest**](RulesRequest.md) | | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
diff --git a/docs/FirewallResponse.md b/docs/FirewallResponse.md
index 60df555..6ba62ec 100644
--- a/docs/FirewallResponse.md
+++ b/docs/FirewallResponse.md
@@ -9,11 +9,11 @@ Name | Type | Description | Notes
**firewall_id** | **str** | Your firewall id. |
**name** | **str** | The name of the firewall. |
**description** | **str** | The description of the firewall. |
-**status** | **str** | Status of the firewall. |
+**status** | **str** | Inactive status means no rules of this firewall are set for all assigned instances. |
**instance_status** | [**[InstanceStatusRepresentation]**](InstanceStatusRepresentation.md) | |
**instances** | [**[InstanceDetails]**](InstanceDetails.md) | |
**rules** | [**Rules**](Rules.md) | |
-**is_default** | **bool** | Specifies whether a firewall is default or not. |
+**is_default** | **bool** | The default firewall rules are assigned by default to newly created instances with Firewall Add-On if not specified otherwise. Exactly one firewall can be set as default. |
**created_date** | **datetime** | The creation date time for the firewall |
**updated_date** | **datetime** | The update date time for the firewall |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
diff --git a/docs/FirewallRuleRequest.md b/docs/FirewallRuleRequest.md
index 9d2afc2..70e734f 100644
--- a/docs/FirewallRuleRequest.md
+++ b/docs/FirewallRuleRequest.md
@@ -4,11 +4,11 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**protocol** | **str** | Protocol for defining the connection type. |
-**dest_ports** | **[str]** | Ports for which the rules will be applied |
+**protocol** | **str** | Protocol for incoming traffic to be allowed. ‘tcp‘, ´udp´, ´icmp´ or ´´ empty value are allowed. Empty means any traffic. |
+**dest_ports** | **[str]** | Ports to specify allowed traffic. Not available for protocol `ICMP`. Port ranges can specified like in example. |
**src_cidr** | [**SrcCidr**](SrcCidr.md) | |
-**action** | **str** | Actions to be applied to the incoming connections. |
-**status** | **str** | Status of the inbound rule. |
+**action** | **str** | Currently only `accept` is supported. |
+**status** | **str** | Status of the inbound rule. An inactive rule is removed from all assigned instances. |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/FirewallRuleResponse.md b/docs/FirewallRuleResponse.md
index 1434d25..14e55a6 100644
--- a/docs/FirewallRuleResponse.md
+++ b/docs/FirewallRuleResponse.md
@@ -4,11 +4,11 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**protocol** | **str** | Protocol for defining the connection type. |
-**dest_ports** | **[str]** | Ports for which the rules will be applied |
+**protocol** | **str** | Protocol for incoming traffic to be allowed. ‘tcp‘, ´udp´, ´icmp´ or ´´ empty value are allowed. Empty means any traffic. |
+**dest_ports** | **[str]** | Ports to specify allowed traffic. Not available for protocol `ICMP`. Port ranges can specified like in example. |
**src_cidr** | [**SrcCidr**](SrcCidr.md) | |
-**action** | **str** | Actions to be applied to the incoming connections. |
-**status** | **str** | Status of the inbound rule. |
+**action** | **str** | Currently only `accept` is supported. |
+**status** | **str** | Status of the inbound rule. An inactive rule is removed from all assigned instances. |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/FirewallsApi.md b/docs/FirewallsApi.md
index 9bc2a31..e673fb9 100644
--- a/docs/FirewallsApi.md
+++ b/docs/FirewallsApi.md
@@ -4,23 +4,23 @@ All URIs are relative to *https://api.contabo.com*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**assign_instance_firewall**](FirewallsApi.md#assign_instance_firewall) | **POST** /v1/firewalls/{firewallId}/instances/{instanceId} | Add instance to a Firewall
-[**create_firewall**](FirewallsApi.md#create_firewall) | **POST** /v1/firewalls | Create a new firewall
-[**delete_firewall**](FirewallsApi.md#delete_firewall) | **DELETE** /v1/firewalls/{firewallId} | Delete existing Firewall by id
-[**patch_firewall**](FirewallsApi.md#patch_firewall) | **PATCH** /v1/firewalls/{firewallId} | Update a Firewall by id
+[**assign_instance_firewall**](FirewallsApi.md#assign_instance_firewall) | **POST** /v1/firewalls/{firewallId}/instances/{instanceId} | Add instance to a firewall
+[**create_firewall**](FirewallsApi.md#create_firewall) | **POST** /v1/firewalls | Create a new firewall definition
+[**delete_firewall**](FirewallsApi.md#delete_firewall) | **DELETE** /v1/firewalls/{firewallId} | Delete existing firewall by id
+[**patch_firewall**](FirewallsApi.md#patch_firewall) | **PATCH** /v1/firewalls/{firewallId} | Update a firewall by id
[**put_firewall**](FirewallsApi.md#put_firewall) | **PUT** /v1/firewalls/{firewallId} | Update specific firewall rules
[**retrieve_firewall**](FirewallsApi.md#retrieve_firewall) | **GET** /v1/firewalls/{firewallId} | Get specific firewall by its id
-[**retrieve_firewall_list**](FirewallsApi.md#retrieve_firewall_list) | **GET** /v1/firewalls | List firewalls
+[**retrieve_firewall_list**](FirewallsApi.md#retrieve_firewall_list) | **GET** /v1/firewalls | List all firewalls
[**set_default_firewall**](FirewallsApi.md#set_default_firewall) | **PUT** /v1/firewalls/{firewallId}/default | Set specific firewall to be default
-[**unassign_instance_firewall**](FirewallsApi.md#unassign_instance_firewall) | **DELETE** /v1/firewalls/{firewallId}/instances/{instanceId} | Remove instance from a Firewall
+[**unassign_instance_firewall**](FirewallsApi.md#unassign_instance_firewall) | **DELETE** /v1/firewalls/{firewallId}/instances/{instanceId} | Remove instance from a firewall
# **assign_instance_firewall**
> AssignInstanceFirewallResponse assign_instance_firewall(x_request_id, firewall_id, instance_id)
-Add instance to a Firewall
+Add instance to a firewall
-Add a specific instance to a Firewall
+Add a specific instance to a firewall
### Example
@@ -53,13 +53,13 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = firewalls_api.FirewallsApi(api_client)
x_request_id = "04e0f898-37b4-48bc-a794-1a57abe6aa31" # str | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
- firewall_id = "b943b25a-c8b5-4570-9135-4bbaa7615b81" # str | The identifier of the Firewall
+ firewall_id = "b943b25a-c8b5-4570-9135-4bbaa7615b81" # str | The identifier of the firewall
instance_id = 100 # int | The identifier of the instance
x_trace_id = "x-trace-id_example" # str | Identifier to trace group of requests. (optional)
# example passing only required values which don't have defaults set
try:
- # Add instance to a Firewall
+ # Add instance to a firewall
api_response = api_instance.assign_instance_firewall(x_request_id, firewall_id, instance_id)
pprint(api_response)
except pfruck_contabo.ApiException as e:
@@ -68,7 +68,7 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
# example passing only required values which don't have defaults set
# and optional values
try:
- # Add instance to a Firewall
+ # Add instance to a firewall
api_response = api_instance.assign_instance_firewall(x_request_id, firewall_id, instance_id, x_trace_id=x_trace_id)
pprint(api_response)
except pfruck_contabo.ApiException as e:
@@ -81,7 +81,7 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_request_id** | **str**| [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually. |
- **firewall_id** | **str**| The identifier of the Firewall |
+ **firewall_id** | **str**| The identifier of the firewall |
**instance_id** | **int**| The identifier of the instance |
**x_trace_id** | **str**| Identifier to trace group of requests. | [optional]
@@ -103,16 +103,16 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**201** | The instance will be added to the Firewall | - |
+**201** | The instance will be added to the firewall | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **create_firewall**
> CreateFirewallResponse create_firewall(x_request_id, create_firewall_request)
-Create a new firewall
+Create a new firewall definition
-Create a firewall for you account with the provided setup.
+Create a new firewall definition by specifying its name and a set of rules. The status of the firewall determines whether the rules are active or not.
### Example
@@ -148,7 +148,7 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
x_request_id = "04e0f898-37b4-48bc-a794-1a57abe6aa31" # str | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
create_firewall_request = CreateFirewallRequest(
name="My Firewall",
- description="This is the firewall for instance 1, 2, 3.",
+ description="Allowing incoming HTTP traffic.",
status="active",
rules=RulesRequest(
inbound=[
@@ -171,7 +171,7 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
# example passing only required values which don't have defaults set
try:
- # Create a new firewall
+ # Create a new firewall definition
api_response = api_instance.create_firewall(x_request_id, create_firewall_request)
pprint(api_response)
except pfruck_contabo.ApiException as e:
@@ -180,7 +180,7 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
# example passing only required values which don't have defaults set
# and optional values
try:
- # Create a new firewall
+ # Create a new firewall definition
api_response = api_instance.create_firewall(x_request_id, create_firewall_request, x_trace_id=x_trace_id)
pprint(api_response)
except pfruck_contabo.ApiException as e:
@@ -221,9 +221,9 @@ Name | Type | Description | Notes
# **delete_firewall**
> delete_firewall(x_request_id, firewall_id)
-Delete existing Firewall by id
+Delete existing firewall by id
-Delete existing Firewall by id. A firewall cannot be deleted if there are instances attached to it.
+Delete existing firewall by id. A firewall cannot be deleted if there are instances attached to it.
### Example
@@ -260,7 +260,7 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
# example passing only required values which don't have defaults set
try:
- # Delete existing Firewall by id
+ # Delete existing firewall by id
api_instance.delete_firewall(x_request_id, firewall_id)
except pfruck_contabo.ApiException as e:
print("Exception when calling FirewallsApi->delete_firewall: %s\n" % e)
@@ -268,7 +268,7 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
# example passing only required values which don't have defaults set
# and optional values
try:
- # Delete existing Firewall by id
+ # Delete existing firewall by id
api_instance.delete_firewall(x_request_id, firewall_id, x_trace_id=x_trace_id)
except pfruck_contabo.ApiException as e:
print("Exception when calling FirewallsApi->delete_firewall: %s\n" % e)
@@ -308,9 +308,9 @@ void (empty response body)
# **patch_firewall**
> PatchFirewallResponse patch_firewall(x_request_id, firewall_id, patch_firewall_request)
-Update a Firewall by id
+Update a firewall by id
-Update a Firewall by id in your account.
+Update a firewall by id in your account.
### Example
@@ -348,13 +348,13 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
patch_firewall_request = PatchFirewallRequest(
name="My Firewall",
status="active",
- description="Firewall description",
+ description="Allowing incoming HTTP traffic.",
) # PatchFirewallRequest |
x_trace_id = "x-trace-id_example" # str | Identifier to trace group of requests. (optional)
# example passing only required values which don't have defaults set
try:
- # Update a Firewall by id
+ # Update a firewall by id
api_response = api_instance.patch_firewall(x_request_id, firewall_id, patch_firewall_request)
pprint(api_response)
except pfruck_contabo.ApiException as e:
@@ -363,7 +363,7 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
# example passing only required values which don't have defaults set
# and optional values
try:
- # Update a Firewall by id
+ # Update a firewall by id
api_response = api_instance.patch_firewall(x_request_id, firewall_id, patch_firewall_request, x_trace_id=x_trace_id)
pprint(api_response)
except pfruck_contabo.ApiException as e:
@@ -398,7 +398,7 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | The response will be a JSON object and contains standard Firewall attributes. | - |
+**200** | The response will be a JSON object and contains standard firewall attributes. | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
@@ -407,7 +407,7 @@ Name | Type | Description | Notes
Update specific firewall rules
-Set rules for a specific firewall
+Set rules for a specific firewall. Currently only inbound rules are allowed to be configured.
### Example
@@ -605,9 +605,9 @@ Name | Type | Description | Notes
# **retrieve_firewall_list**
> ListFirewallResponse retrieve_firewall_list(x_request_id)
-List firewalls
+List all firewalls
-List and filter all Firewalls in your account
+List and filter all firewalls on your account
### Example
@@ -646,13 +646,12 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
order_by = [
"name:asc",
] # [str] | Specify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC|DESC`. (optional)
- name = "myFirewall" # str | The name of the Firewall (optional)
- customer_id = "54321" # str | The customer ID (optional)
- is_default = True # bool | Whether the firewall is default or not (optional)
+ name = "My Firewall" # str | The name of the firewall (optional)
+ is_default = True # bool | The default firewall rules are assigned by default to newly created instances with Firewall Add-On if not specified otherwise. Exactly one firewall can be set as default. (optional)
# example passing only required values which don't have defaults set
try:
- # List firewalls
+ # List all firewalls
api_response = api_instance.retrieve_firewall_list(x_request_id)
pprint(api_response)
except pfruck_contabo.ApiException as e:
@@ -661,8 +660,8 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
# example passing only required values which don't have defaults set
# and optional values
try:
- # List firewalls
- api_response = api_instance.retrieve_firewall_list(x_request_id, x_trace_id=x_trace_id, page=page, size=size, order_by=order_by, name=name, customer_id=customer_id, is_default=is_default)
+ # List all firewalls
+ api_response = api_instance.retrieve_firewall_list(x_request_id, x_trace_id=x_trace_id, page=page, size=size, order_by=order_by, name=name, is_default=is_default)
pprint(api_response)
except pfruck_contabo.ApiException as e:
print("Exception when calling FirewallsApi->retrieve_firewall_list: %s\n" % e)
@@ -678,9 +677,8 @@ Name | Type | Description | Notes
**page** | **int**| Number of page to be fetched. | [optional]
**size** | **int**| Number of elements per page. | [optional]
**order_by** | **[str]**| Specify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC|DESC`. | [optional]
- **name** | **str**| The name of the Firewall | [optional]
- **customer_id** | **str**| The customer ID | [optional]
- **is_default** | **bool**| Whether the firewall is default or not | [optional]
+ **name** | **str**| The name of the firewall | [optional]
+ **is_default** | **bool**| The default firewall rules are assigned by default to newly created instances with Firewall Add-On if not specified otherwise. Exactly one firewall can be set as default. | [optional]
### Return type
@@ -709,7 +707,7 @@ Name | Type | Description | Notes
Set specific firewall to be default
-Set a specific firewall to be the default
+Only one firewall can be spicified as default. Newly-added VPS/VDS with a Firewall Add-on will be automatically assigned to the default firewall.
### Example
@@ -797,9 +795,9 @@ Name | Type | Description | Notes
# **unassign_instance_firewall**
> UnassignInstanceFirewallResponse unassign_instance_firewall(x_request_id, firewall_id, instance_id)
-Remove instance from a Firewall
+Remove instance from a firewall
-Remove a specific instance from a Firewall
+Remove a specific instance from a firewall
### Example
@@ -832,13 +830,13 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = firewalls_api.FirewallsApi(api_client)
x_request_id = "04e0f898-37b4-48bc-a794-1a57abe6aa31" # str | [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
- firewall_id = "b943b25a-c8b5-4570-9135-4bbaa7615b81" # str | The identifier of the Firewall
+ firewall_id = "b943b25a-c8b5-4570-9135-4bbaa7615b81" # str | The identifier of the firewall
instance_id = 100 # int | The identifier of the instance
x_trace_id = "x-trace-id_example" # str | Identifier to trace group of requests. (optional)
# example passing only required values which don't have defaults set
try:
- # Remove instance from a Firewall
+ # Remove instance from a firewall
api_response = api_instance.unassign_instance_firewall(x_request_id, firewall_id, instance_id)
pprint(api_response)
except pfruck_contabo.ApiException as e:
@@ -847,7 +845,7 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
# example passing only required values which don't have defaults set
# and optional values
try:
- # Remove instance from a Firewall
+ # Remove instance from a firewall
api_response = api_instance.unassign_instance_firewall(x_request_id, firewall_id, instance_id, x_trace_id=x_trace_id)
pprint(api_response)
except pfruck_contabo.ApiException as e:
@@ -860,7 +858,7 @@ with pfruck_contabo.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_request_id** | **str**| [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually. |
- **firewall_id** | **str**| The identifier of the Firewall |
+ **firewall_id** | **str**| The identifier of the firewall |
**instance_id** | **int**| The identifier of the instance |
**x_trace_id** | **str**| Identifier to trace group of requests. | [optional]
@@ -882,7 +880,7 @@ Name | Type | Description | Notes
| Status code | Description | Response headers |
|-------------|-------------|------------------|
-**200** | The instance will be removed from the Firewall | - |
+**200** | The instance will be removed from the firewall | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
diff --git a/docs/InstanceAssignmentSelfLinks.md b/docs/InstanceAssignmentSelfLinks.md
index 306b222..fdc4705 100644
--- a/docs/InstanceAssignmentSelfLinks.md
+++ b/docs/InstanceAssignmentSelfLinks.md
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_self** | **str** | Link to current resource. |
-**firewall** | **str** | Link to related Firewall. |
+**firewall** | **str** | Link to related firewall. |
**instance** | **str** | Link to assigned instance. |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
diff --git a/docs/InstanceDetails.md b/docs/InstanceDetails.md
index f26de29..8cdb39f 100644
--- a/docs/InstanceDetails.md
+++ b/docs/InstanceDetails.md
@@ -4,13 +4,12 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**instance_id** | **int** | Instance id |
+**instance_id** | **int** | Instance id which is assigned to firewall |
**display_name** | **str** | Instance display name |
**name** | **str** | Instance name |
**product_id** | **str** | Product id |
**ip_config** | [**IpConfig**](IpConfig.md) | |
**region** | **str** | Region where the instance is located. |
-**error_message** | **str** | Message in case of an error. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/InstanceStatusRepresentation.md b/docs/InstanceStatusRepresentation.md
index 636688b..e324be0 100644
--- a/docs/InstanceStatusRepresentation.md
+++ b/docs/InstanceStatusRepresentation.md
@@ -4,9 +4,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**instance_id** | **int** | Instance id |
-**status** | **str** | Instance Status in Firewall |
-**error_message** | **str** | Error Message incase of error | [optional]
+**instance_id** | **int** | Instance id which is assigned to the firewall. |
+**status** | **str** | Instance status in firewall can be:<br/> `ok` - instance was successfully assigned <br/> `processing` - creating firewall rules <br/> `deleting` - deleting firewall rules <br/> `error_processing` - error occurred while creating firewall rules <br/> `error_deleting` - error occurred while deleting firewall rules |
+**error_message** | **str** | More detailed error message in case of error status. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/ListFirewallResponseData.md b/docs/ListFirewallResponseData.md
index f22349e..88c6726 100644
--- a/docs/ListFirewallResponseData.md
+++ b/docs/ListFirewallResponseData.md
@@ -9,11 +9,11 @@ Name | Type | Description | Notes
**firewall_id** | **str** | Your firewall id. |
**name** | **str** | The name of the firewall. |
**description** | **str** | The description of the firewall. |
-**status** | **str** | Status of the firewall. |
+**status** | **str** | Inactive status means no rules of this firewall are set for all assigned instances. |
**instance_status** | [**[InstanceStatusRepresentation]**](InstanceStatusRepresentation.md) | |
**instances** | [**[InstanceDetails]**](InstanceDetails.md) | |
**rules** | [**Rules**](Rules.md) | |
-**is_default** | **bool** | Specifies whether a firewall is default or not. |
+**is_default** | **bool** | The default firewall rules are assigned by default to newly created instances with Firewall Add-On if not specified otherwise. Exactly one firewall can be set as default. |
**created_date** | **datetime** | The creation date time for the firewall |
**updated_date** | **datetime** | The update date time for the firewall |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
diff --git a/docs/PatchFirewallRequest.md b/docs/PatchFirewallRequest.md
index 4eca26d..5a3bd9f 100644
--- a/docs/PatchFirewallRequest.md
+++ b/docs/PatchFirewallRequest.md
@@ -4,9 +4,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**name** | **str** | The name of the Firewall | [optional]
-**status** | **str** | The status of the Firewall. It can be either \"active\" or \"inactive\" | [optional]
-**description** | **str** | The description of the Firewall. | [optional]
+**name** | **str** | The name of the firewall | [optional]
+**status** | **str** | Active status of the firewall enables all rules, thus filtering traffic. Inactive status does not filter any traffic. | [optional]
+**description** | **str** | The description of the firewall. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/pfruck_contabo/api/firewalls_api.py b/pfruck_contabo/api/firewalls_api.py
index bd504d8..9107b41 100644
--- a/pfruck_contabo/api/firewalls_api.py
+++ b/pfruck_contabo/api/firewalls_api.py
@@ -497,7 +497,6 @@ def __init__(self, api_client=None):
'size',
'order_by',
'name',
- 'customer_id',
'is_default',
],
'required': [
@@ -535,8 +534,6 @@ def __init__(self, api_client=None):
([str],),
'name':
(str,),
- 'customer_id':
- (str,),
'is_default':
(bool,),
},
@@ -547,7 +544,6 @@ def __init__(self, api_client=None):
'size': 'size',
'order_by': 'orderBy',
'name': 'name',
- 'customer_id': 'customerId',
'is_default': 'isDefault',
},
'location_map': {
@@ -557,7 +553,6 @@ def __init__(self, api_client=None):
'size': 'query',
'order_by': 'query',
'name': 'query',
- 'customer_id': 'query',
'is_default': 'query',
},
'collection_format_map': {
@@ -724,9 +719,9 @@ def assign_instance_firewall(
instance_id,
**kwargs
):
- """Add instance to a Firewall # noqa: E501
+ """Add instance to a firewall # noqa: E501
- Add a specific instance to a Firewall # noqa: E501
+ Add a specific instance to a firewall # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -735,7 +730,7 @@ def assign_instance_firewall(
Args:
x_request_id (str): [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
- firewall_id (str): The identifier of the Firewall
+ firewall_id (str): The identifier of the firewall
instance_id (int): The identifier of the instance
Keyword Args:
@@ -815,9 +810,9 @@ def create_firewall(
create_firewall_request,
**kwargs
):
- """Create a new firewall # noqa: E501
+ """Create a new firewall definition # noqa: E501
- Create a firewall for you account with the provided setup. # noqa: E501
+ Create a new firewall definition by specifying its name and a set of rules. The status of the firewall determines whether the rules are active or not. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -903,9 +898,9 @@ def delete_firewall(
firewall_id,
**kwargs
):
- """Delete existing Firewall by id # noqa: E501
+ """Delete existing firewall by id # noqa: E501
- Delete existing Firewall by id. A firewall cannot be deleted if there are instances attached to it. # noqa: E501
+ Delete existing firewall by id. A firewall cannot be deleted if there are instances attached to it. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -992,9 +987,9 @@ def patch_firewall(
patch_firewall_request,
**kwargs
):
- """Update a Firewall by id # noqa: E501
+ """Update a firewall by id # noqa: E501
- Update a Firewall by id in your account. # noqa: E501
+ Update a firewall by id in your account. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1086,7 +1081,7 @@ def put_firewall(
):
"""Update specific firewall rules # noqa: E501
- Set rules for a specific firewall # noqa: E501
+ Set rules for a specific firewall. Currently only inbound rules are allowed to be configured. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1262,9 +1257,9 @@ def retrieve_firewall_list(
x_request_id,
**kwargs
):
- """List firewalls # noqa: E501
+ """List all firewalls # noqa: E501
- List and filter all Firewalls in your account # noqa: E501
+ List and filter all firewalls on your account # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1279,9 +1274,8 @@ def retrieve_firewall_list(
page (int): Number of page to be fetched.. [optional]
size (int): Number of elements per page.. [optional]
order_by ([str]): Specify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC|DESC`.. [optional]
- name (str): The name of the Firewall. [optional]
- customer_id (str): The customer ID. [optional]
- is_default (bool): Whether the firewall is default or not. [optional]
+ name (str): The name of the firewall. [optional]
+ is_default (bool): The default firewall rules are assigned by default to newly created instances with Firewall Add-On if not specified otherwise. Exactly one firewall can be set as default.. [optional]
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -1355,7 +1349,7 @@ def set_default_firewall(
):
"""Set specific firewall to be default # noqa: E501
- Set a specific firewall to be the default # noqa: E501
+ Only one firewall can be spicified as default. Newly-added VPS/VDS with a Firewall Add-on will be automatically assigned to the default firewall. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1442,9 +1436,9 @@ def unassign_instance_firewall(
instance_id,
**kwargs
):
- """Remove instance from a Firewall # noqa: E501
+ """Remove instance from a firewall # noqa: E501
- Remove a specific instance from a Firewall # noqa: E501
+ Remove a specific instance from a firewall # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
@@ -1453,7 +1447,7 @@ def unassign_instance_firewall(
Args:
x_request_id (str): [Uuid4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)) to identify individual requests for support cases. You can use [uuidgenerator](https://www.uuidgenerator.net/version4) to generate them manually.
- firewall_id (str): The identifier of the Firewall
+ firewall_id (str): The identifier of the firewall
instance_id (int): The identifier of the instance
Keyword Args:
diff --git a/pfruck_contabo/model/assign_instance_firewall_response_links.py b/pfruck_contabo/model/assign_instance_firewall_response_links.py
index ece63b3..6b0cc5b 100644
--- a/pfruck_contabo/model/assign_instance_firewall_response_links.py
+++ b/pfruck_contabo/model/assign_instance_firewall_response_links.py
@@ -113,7 +113,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Keyword Args:
_self (str): Link to current resource.
- firewall (str): Link to related Firewall.
+ firewall (str): Link to related firewall.
instance (str): Link to assigned instance.
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
@@ -219,7 +219,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
Keyword Args:
_self (str): Link to current resource.
- firewall (str): Link to related Firewall.
+ firewall (str): Link to related firewall.
instance (str): Link to assigned instance.
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
diff --git a/pfruck_contabo/model/create_firewall_request.py b/pfruck_contabo/model/create_firewall_request.py
index 482c08e..2ff1102 100644
--- a/pfruck_contabo/model/create_firewall_request.py
+++ b/pfruck_contabo/model/create_firewall_request.py
@@ -127,7 +127,7 @@ def _from_openapi_data(cls, name, status, *args, **kwargs): # noqa: E501
Args:
name (str): The name of the firewall.
- status (str): Status of the firewall.
+ status (str): The status of the firewall determines whether the rules are active or not.
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
@@ -220,7 +220,7 @@ def __init__(self, name, status, *args, **kwargs): # noqa: E501
Args:
name (str): The name of the firewall.
- status (str): Status of the firewall.
+ status (str): The status of the firewall determines whether the rules are active or not.
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
diff --git a/pfruck_contabo/model/firewall_response.py b/pfruck_contabo/model/firewall_response.py
index d0825cb..52c0ebf 100644
--- a/pfruck_contabo/model/firewall_response.py
+++ b/pfruck_contabo/model/firewall_response.py
@@ -160,11 +160,11 @@ def _from_openapi_data(cls, tenant_id, customer_id, firewall_id, name, descripti
firewall_id (str): Your firewall id.
name (str): The name of the firewall.
description (str): The description of the firewall.
- status (str): Status of the firewall.
+ status (str): Inactive status means no rules of this firewall are set for all assigned instances.
instance_status ([InstanceStatusRepresentation]):
instances ([InstanceDetails]):
rules (Rules):
- is_default (bool): Specifies whether a firewall is default or not.
+ is_default (bool): The default firewall rules are assigned by default to newly created instances with Firewall Add-On if not specified otherwise. Exactly one firewall can be set as default.
created_date (datetime): The creation date time for the firewall
updated_date (datetime): The update date time for the firewall
@@ -271,11 +271,11 @@ def __init__(self, tenant_id, customer_id, firewall_id, name, description, statu
firewall_id (str): Your firewall id.
name (str): The name of the firewall.
description (str): The description of the firewall.
- status (str): Status of the firewall.
+ status (str): Inactive status means no rules of this firewall are set for all assigned instances.
instance_status ([InstanceStatusRepresentation]):
instances ([InstanceDetails]):
rules (Rules):
- is_default (bool): Specifies whether a firewall is default or not.
+ is_default (bool): The default firewall rules are assigned by default to newly created instances with Firewall Add-On if not specified otherwise. Exactly one firewall can be set as default.
created_date (datetime): The creation date time for the firewall
updated_date (datetime): The update date time for the firewall
diff --git a/pfruck_contabo/model/firewall_rule_request.py b/pfruck_contabo/model/firewall_rule_request.py
index 6a5dcac..010be05 100644
--- a/pfruck_contabo/model/firewall_rule_request.py
+++ b/pfruck_contabo/model/firewall_rule_request.py
@@ -132,11 +132,11 @@ def _from_openapi_data(cls, protocol, dest_ports, src_cidr, action, status, *arg
"""FirewallRuleRequest - a model defined in OpenAPI
Args:
- protocol (str): Protocol for defining the connection type.
- dest_ports ([str]): Ports for which the rules will be applied
+ protocol (str): Protocol for incoming traffic to be allowed. ‘tcp‘, ´udp´, ´icmp´ or ´´ empty value are allowed. Empty means any traffic.
+ dest_ports ([str]): Ports to specify allowed traffic. Not available for protocol `ICMP`. Port ranges can specified like in example.
src_cidr (SrcCidr):
- action (str): Actions to be applied to the incoming connections.
- status (str): Status of the inbound rule.
+ action (str): Currently only `accept` is supported.
+ status (str): Status of the inbound rule. An inactive rule is removed from all assigned instances.
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
@@ -229,11 +229,11 @@ def __init__(self, protocol, dest_ports, src_cidr, action, status, *args, **kwar
"""FirewallRuleRequest - a model defined in OpenAPI
Args:
- protocol (str): Protocol for defining the connection type.
- dest_ports ([str]): Ports for which the rules will be applied
+ protocol (str): Protocol for incoming traffic to be allowed. ‘tcp‘, ´udp´, ´icmp´ or ´´ empty value are allowed. Empty means any traffic.
+ dest_ports ([str]): Ports to specify allowed traffic. Not available for protocol `ICMP`. Port ranges can specified like in example.
src_cidr (SrcCidr):
- action (str): Actions to be applied to the incoming connections.
- status (str): Status of the inbound rule.
+ action (str): Currently only `accept` is supported.
+ status (str): Status of the inbound rule. An inactive rule is removed from all assigned instances.
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
diff --git a/pfruck_contabo/model/firewall_rule_response.py b/pfruck_contabo/model/firewall_rule_response.py
index efb97b2..99f214f 100644
--- a/pfruck_contabo/model/firewall_rule_response.py
+++ b/pfruck_contabo/model/firewall_rule_response.py
@@ -132,11 +132,11 @@ def _from_openapi_data(cls, protocol, dest_ports, src_cidr, action, status, *arg
"""FirewallRuleResponse - a model defined in OpenAPI
Args:
- protocol (str): Protocol for defining the connection type.
- dest_ports ([str]): Ports for which the rules will be applied
+ protocol (str): Protocol for incoming traffic to be allowed. ‘tcp‘, ´udp´, ´icmp´ or ´´ empty value are allowed. Empty means any traffic.
+ dest_ports ([str]): Ports to specify allowed traffic. Not available for protocol `ICMP`. Port ranges can specified like in example.
src_cidr (SrcCidr):
- action (str): Actions to be applied to the incoming connections.
- status (str): Status of the inbound rule.
+ action (str): Currently only `accept` is supported.
+ status (str): Status of the inbound rule. An inactive rule is removed from all assigned instances.
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
@@ -229,11 +229,11 @@ def __init__(self, protocol, dest_ports, src_cidr, action, status, *args, **kwar
"""FirewallRuleResponse - a model defined in OpenAPI
Args:
- protocol (str): Protocol for defining the connection type.
- dest_ports ([str]): Ports for which the rules will be applied
+ protocol (str): Protocol for incoming traffic to be allowed. ‘tcp‘, ´udp´, ´icmp´ or ´´ empty value are allowed. Empty means any traffic.
+ dest_ports ([str]): Ports to specify allowed traffic. Not available for protocol `ICMP`. Port ranges can specified like in example.
src_cidr (SrcCidr):
- action (str): Actions to be applied to the incoming connections.
- status (str): Status of the inbound rule.
+ action (str): Currently only `accept` is supported.
+ status (str): Status of the inbound rule. An inactive rule is removed from all assigned instances.
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
diff --git a/pfruck_contabo/model/instance_assignment_self_links.py b/pfruck_contabo/model/instance_assignment_self_links.py
index 32f7140..203f8f7 100644
--- a/pfruck_contabo/model/instance_assignment_self_links.py
+++ b/pfruck_contabo/model/instance_assignment_self_links.py
@@ -109,7 +109,7 @@ def _from_openapi_data(cls, _self, firewall, instance, *args, **kwargs): # noqa
Args:
_self (str): Link to current resource.
- firewall (str): Link to related Firewall.
+ firewall (str): Link to related firewall.
instance (str): Link to assigned instance.
Keyword Args:
@@ -202,7 +202,7 @@ def __init__(self, _self, firewall, instance, *args, **kwargs): # noqa: E501
Args:
_self (str): Link to current resource.
- firewall (str): Link to related Firewall.
+ firewall (str): Link to related firewall.
instance (str): Link to assigned instance.
Keyword Args:
diff --git a/pfruck_contabo/model/instance_details.py b/pfruck_contabo/model/instance_details.py
index 26660e0..8bd7694 100644
--- a/pfruck_contabo/model/instance_details.py
+++ b/pfruck_contabo/model/instance_details.py
@@ -93,7 +93,6 @@ def openapi_types():
'product_id': (str,), # noqa: E501
'ip_config': (IpConfig,), # noqa: E501
'region': (str,), # noqa: E501
- 'error_message': (str,), # noqa: E501
}
@cached_property
@@ -108,7 +107,6 @@ def discriminator():
'product_id': 'productId', # noqa: E501
'ip_config': 'ipConfig', # noqa: E501
'region': 'region', # noqa: E501
- 'error_message': 'errorMessage', # noqa: E501
}
read_only_vars = {
@@ -122,7 +120,7 @@ def _from_openapi_data(cls, instance_id, display_name, name, product_id, ip_conf
"""InstanceDetails - a model defined in OpenAPI
Args:
- instance_id (int): Instance id
+ instance_id (int): Instance id which is assigned to firewall
display_name (str): Instance display name
name (str): Instance name
product_id (str): Product id
@@ -160,7 +158,6 @@ def _from_openapi_data(cls, instance_id, display_name, name, product_id, ip_conf
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- error_message (str): Message in case of an error.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -222,7 +219,7 @@ def __init__(self, instance_id, display_name, name, product_id, ip_config, regio
"""InstanceDetails - a model defined in OpenAPI
Args:
- instance_id (int): Instance id
+ instance_id (int): Instance id which is assigned to firewall
display_name (str): Instance display name
name (str): Instance name
product_id (str): Product id
@@ -260,7 +257,6 @@ def __init__(self, instance_id, display_name, name, product_id, ip_config, regio
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- error_message (str): Message in case of an error.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/pfruck_contabo/model/instance_status_representation.py b/pfruck_contabo/model/instance_status_representation.py
index ec8315f..2f65ca3 100644
--- a/pfruck_contabo/model/instance_status_representation.py
+++ b/pfruck_contabo/model/instance_status_representation.py
@@ -115,8 +115,8 @@ def _from_openapi_data(cls, instance_id, status, *args, **kwargs): # noqa: E501
"""InstanceStatusRepresentation - a model defined in OpenAPI
Args:
- instance_id (int): Instance id
- status (str): Instance Status in Firewall
+ instance_id (int): Instance id which is assigned to the firewall.
+ status (str): Instance status in firewall can be:
`ok` - instance was successfully assigned
`processing` - creating firewall rules
`deleting` - deleting firewall rules
`error_processing` - error occurred while creating firewall rules
`error_deleting` - error occurred while deleting firewall rules
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
@@ -149,7 +149,7 @@ def _from_openapi_data(cls, instance_id, status, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- error_message (str): Error Message incase of error. [optional] # noqa: E501
+ error_message (str): More detailed error message in case of error status.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -207,8 +207,8 @@ def __init__(self, instance_id, status, *args, **kwargs): # noqa: E501
"""InstanceStatusRepresentation - a model defined in OpenAPI
Args:
- instance_id (int): Instance id
- status (str): Instance Status in Firewall
+ instance_id (int): Instance id which is assigned to the firewall.
+ status (str): Instance status in firewall can be:
`ok` - instance was successfully assigned
`processing` - creating firewall rules
`deleting` - deleting firewall rules
`error_processing` - error occurred while creating firewall rules
`error_deleting` - error occurred while deleting firewall rules
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
@@ -241,7 +241,7 @@ def __init__(self, instance_id, status, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- error_message (str): Error Message incase of error. [optional] # noqa: E501
+ error_message (str): More detailed error message in case of error status.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/pfruck_contabo/model/list_firewall_response_data.py b/pfruck_contabo/model/list_firewall_response_data.py
index 89625b1..0fa7aee 100644
--- a/pfruck_contabo/model/list_firewall_response_data.py
+++ b/pfruck_contabo/model/list_firewall_response_data.py
@@ -160,11 +160,11 @@ def _from_openapi_data(cls, tenant_id, customer_id, firewall_id, name, descripti
firewall_id (str): Your firewall id.
name (str): The name of the firewall.
description (str): The description of the firewall.
- status (str): Status of the firewall.
+ status (str): Inactive status means no rules of this firewall are set for all assigned instances.
instance_status ([InstanceStatusRepresentation]):
instances ([InstanceDetails]):
rules (Rules):
- is_default (bool): Specifies whether a firewall is default or not.
+ is_default (bool): The default firewall rules are assigned by default to newly created instances with Firewall Add-On if not specified otherwise. Exactly one firewall can be set as default.
created_date (datetime): The creation date time for the firewall
updated_date (datetime): The update date time for the firewall
@@ -271,11 +271,11 @@ def __init__(self, tenant_id, customer_id, firewall_id, name, description, statu
firewall_id (str): Your firewall id.
name (str): The name of the firewall.
description (str): The description of the firewall.
- status (str): Status of the firewall.
+ status (str): Inactive status means no rules of this firewall are set for all assigned instances.
instance_status ([InstanceStatusRepresentation]):
instances ([InstanceDetails]):
rules (Rules):
- is_default (bool): Specifies whether a firewall is default or not.
+ is_default (bool): The default firewall rules are assigned by default to newly created instances with Firewall Add-On if not specified otherwise. Exactly one firewall can be set as default.
created_date (datetime): The creation date time for the firewall
updated_date (datetime): The update date time for the firewall
diff --git a/pfruck_contabo/model/patch_firewall_request.py b/pfruck_contabo/model/patch_firewall_request.py
index 014b536..ac56c3f 100644
--- a/pfruck_contabo/model/patch_firewall_request.py
+++ b/pfruck_contabo/model/patch_firewall_request.py
@@ -146,9 +146,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- name (str): The name of the Firewall. [optional] # noqa: E501
- status (str): The status of the Firewall. It can be either \"active\" or \"inactive\". [optional] # noqa: E501
- description (str): The description of the Firewall.. [optional] # noqa: E501
+ name (str): The name of the firewall. [optional] # noqa: E501
+ status (str): Active status of the firewall enables all rules, thus filtering traffic. Inactive status does not filter any traffic.. [optional] # noqa: E501
+ description (str): The description of the firewall.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
@@ -234,9 +234,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
- name (str): The name of the Firewall. [optional] # noqa: E501
- status (str): The status of the Firewall. It can be either \"active\" or \"inactive\". [optional] # noqa: E501
- description (str): The description of the Firewall.. [optional] # noqa: E501
+ name (str): The name of the firewall. [optional] # noqa: E501
+ status (str): Active status of the firewall enables all rules, thus filtering traffic. Inactive status does not filter any traffic.. [optional] # noqa: E501
+ description (str): The description of the firewall.. [optional] # noqa: E501
"""
_check_type = kwargs.pop('_check_type', True)
diff --git a/setup.py b/setup.py
index 444eb06..9ec1588 100644
--- a/setup.py
+++ b/setup.py
@@ -135,15 +135,15 @@
------------ | ------------- | ------------- | -------------
*CustomerApi* | [**retrieve_customer**](https://github.com/p-fruck/python-contabo/blob/main/docs/CustomerApi.md#retrieve_customer) | **GET** /v1/customer | Get customer info
*CustomerApi* | [**retrieve_payment_method**](https://github.com/p-fruck/python-contabo/blob/main/docs/CustomerApi.md#retrieve_payment_method) | **GET** /v1/customer/payment-method | List current payment method
-*FirewallsApi* | [**assign_instance_firewall**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#assign_instance_firewall) | **POST** /v1/firewalls/{firewallId}/instances/{instanceId} | Add instance to a Firewall
-*FirewallsApi* | [**create_firewall**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#create_firewall) | **POST** /v1/firewalls | Create a new firewall
-*FirewallsApi* | [**delete_firewall**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#delete_firewall) | **DELETE** /v1/firewalls/{firewallId} | Delete existing Firewall by id
-*FirewallsApi* | [**patch_firewall**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#patch_firewall) | **PATCH** /v1/firewalls/{firewallId} | Update a Firewall by id
+*FirewallsApi* | [**assign_instance_firewall**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#assign_instance_firewall) | **POST** /v1/firewalls/{firewallId}/instances/{instanceId} | Add instance to a firewall
+*FirewallsApi* | [**create_firewall**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#create_firewall) | **POST** /v1/firewalls | Create a new firewall definition
+*FirewallsApi* | [**delete_firewall**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#delete_firewall) | **DELETE** /v1/firewalls/{firewallId} | Delete existing firewall by id
+*FirewallsApi* | [**patch_firewall**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#patch_firewall) | **PATCH** /v1/firewalls/{firewallId} | Update a firewall by id
*FirewallsApi* | [**put_firewall**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#put_firewall) | **PUT** /v1/firewalls/{firewallId} | Update specific firewall rules
*FirewallsApi* | [**retrieve_firewall**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#retrieve_firewall) | **GET** /v1/firewalls/{firewallId} | Get specific firewall by its id
-*FirewallsApi* | [**retrieve_firewall_list**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#retrieve_firewall_list) | **GET** /v1/firewalls | List firewalls
+*FirewallsApi* | [**retrieve_firewall_list**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#retrieve_firewall_list) | **GET** /v1/firewalls | List all firewalls
*FirewallsApi* | [**set_default_firewall**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#set_default_firewall) | **PUT** /v1/firewalls/{firewallId}/default | Set specific firewall to be default
-*FirewallsApi* | [**unassign_instance_firewall**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#unassign_instance_firewall) | **DELETE** /v1/firewalls/{firewallId}/instances/{instanceId} | Remove instance from a Firewall
+*FirewallsApi* | [**unassign_instance_firewall**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsApi.md#unassign_instance_firewall) | **DELETE** /v1/firewalls/{firewallId}/instances/{instanceId} | Remove instance from a firewall
*FirewallsAuditsApi* | [**retrieve_firewall_audits_list**](https://github.com/p-fruck/python-contabo/blob/main/docs/FirewallsAuditsApi.md#retrieve_firewall_audits_list) | **GET** /v1/firewalls/audits | List history about your Firewalls (audit)
*ImagesApi* | [**create_custom_image**](https://github.com/p-fruck/python-contabo/blob/main/docs/ImagesApi.md#create_custom_image) | **POST** /v1/compute/images | Provide a custom image
*ImagesApi* | [**delete_image**](https://github.com/p-fruck/python-contabo/blob/main/docs/ImagesApi.md#delete_image) | **DELETE** /v1/compute/images/{imageId} | Delete an uploaded custom image by its id