Types
FirewallActionSortOption = enum sortId = "id", sortIdAsc = "id:asc", sortIdDesc = "id:desc", sortCommand = "command", sortCommandAsc = "command:asc", sortCommandDesc = "command:desc", sortStatus = "status", sortStatusAsc = "status:asc", sortStatusDesc = "status:desc", sortProgress = "progress", sortProgressAsc = "progress:asc", sortProgressDesc = "progress:desc", sortStarted = "started", sortStartedAsc = "started:asc", sortStartedDesc = "started:desc", sortFinished = "finished", sortFinishedAsc = "finished:asc", sortFinishedDesc = "finished:desc"
FirewallActionStatusOption = enum statusRunning = "running", statusSuccess = "success", statusError = "error"
GetFirewallsIdActionsResponse = object
Procs
proc getFirewallsIdActions(client: HetznerClient; id: int64; sort: set[FirewallActionSortOption] = {}; status: set[FirewallActionStatusOption] = {}): Future[ GetFirewallsIdActionsResponse] {....stackTrace: false, raises: [Exception, ValueError, KeyError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, OpenParserJsonError, HetznerClientError], tags: [ RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
- Returns all Action objects for a Firewall. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
proc getFirewallsIdActionsActionId(client: HetznerClient; id: int64; actionId: int64): Future[ GetFirewallsIdActionsActionIdResponse] {....stackTrace: false, raises: [ Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
- Returns a specific Action for a Firewall.
proc postFirewallsIdActionsApplyToResources(client: HetznerClient; id: int64; body: PostFirewallsIdActionsApplyToResourcesRequest): Future[ PostFirewallsIdActionsApplyToResourcesResponse] {....stackTrace: false, raises: [ Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
-
Applies one Firewall to multiple resources. Currently servers (public network interface) and label selectors are supported. #### Call specific error codes | Code | Description | |-------------------------------|----------------------------------------------- ----------------| | `firewall_already_applied` | Firewall was already applied on resource | | `incompatible_network_type` | The Network type is incompatible for the given resource | | `firewall_resource_not_found` | The resource the Firewall should be attached to was not found |
proc postFirewallsIdActionsRemoveFromResources(client: HetznerClient; id: int64; body: PostFirewallsIdActionsRemoveFromResourcesRequest): Future[ PostFirewallsIdActionsRemoveFromResourcesResponse] {....stackTrace: false, raises: [ Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
-
Removes one Firewall from multiple resources. Currently only Servers (and their public network interfaces) are supported. #### Call specific error codes | Code | Description | |---------------------------------------|--------------------------------------- ---------------------------------| | `firewall_already_removed` | Firewall was already removed from the resource | | `firewall_resource_not_found` | The resource the Firewall should be attached to was not found | | `firewall_managed_by_label_selector` | Firewall was applied via label selector and cannot be removed manually |
proc postFirewallsIdActionsSetRules(client: HetznerClient; id: int64; body: PostFirewallsIdActionsSetRulesRequest): Future[ PostFirewallsIdActionsSetRulesResponse] {....stackTrace: false, raises: [ Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
-
Sets the rules of a Firewall. All existing rules will be overwritten. Pass an empty `rules` array to remove all rules. The maximum amount of rules that can be defined is 50. #### Call specific error codes | Code | Description | |-------------------------------|----------------------------------------------- ----------------| | `firewall_resource_not_found` | The resource the Firewall should be attached to was not found |