{ "opencollection": "1.0.0", "info": { "name": "Hetzner Cloud Actions Firewall Actions API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Firewall Actions", "type": "folder" }, "items": [ { "info": { "name": "List Actions", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/firewalls/actions", "params": [ { "name": "id", "value": "", "type": "query", "description": "Filter the actions by ID. May be used multiple times.\n\nThe response will only contain actions matching the specified IDs.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort actions by field and direction. May be used multiple times.\n\nFor more information, see \"[Sorting](#description/sorting)\".\n" }, { "name": "status", "value": "", "type": "query", "description": "Filter the actions by status. May be used multiple times.\n\nThe response will only contain actions matching the specified statuses.\n" }, { "name": "page", "value": "", "type": "query", "description": "Page number to return. For more information, see \"[Pagination](#description/pagination)\"." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of entries returned per page. For more information, see \"[Pagination](#description/pagination)\"." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns all [Actions](#tag/actions) for [Firewalls](#tag/firewalls).\n\nUse the provided URI parameters to modify the result.\n" }, { "info": { "name": "Get an Action", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/firewalls/actions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Action." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns the specific [Action](#tag/actions).\n" }, { "info": { "name": "List Actions for a Firewall", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/firewalls/:id/actions", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Firewall." }, { "name": "sort", "value": "", "type": "query", "description": "Sort actions by field and direction. May be used multiple times.\n\nFor more information, see \"[Sorting](#description/sorting)\".\n" }, { "name": "status", "value": "", "type": "query", "description": "Filter the actions by status. May be used multiple times.\n\nThe response will only contain actions matching the specified statuses.\n" }, { "name": "page", "value": "", "type": "query", "description": "Page number to return. For more information, see \"[Pagination](#description/pagination)\"." }, { "name": "per_page", "value": "", "type": "query", "description": "Maximum number of entries returned per page. For more information, see \"[Pagination](#description/pagination)\"." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns all [Actions](#tag/actions) for the [Firewall](#tag/firewalls).\n\nUse the provided URI parameters to modify the result.\n" }, { "info": { "name": "Apply to Resources", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/firewalls/:id/actions/apply_to_resources", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Firewall." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Applies a [Firewall](#tag/firewalls) to multiple resources.\n\nSupported resources:\n- [Servers](#tag/servers) (with a public network interface)\n- [Label Selectors](#description/label-selector)\n\nA [Server](#tag/servers) can be applied to [a maximum of 5 Firewalls](https://docs.hetzner.com/cloud/firewalls/overview#limits). This limit\napplies to [Servers](#tag/servers) applied via a matching [Label Selector](#description/label-selector) as well.\n\nUpdates to resources matching or no longer matching a " }, { "info": { "name": "Remove from Resources", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/firewalls/:id/actions/remove_from_resources", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Firewall." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Removes a [Firewall](#tag/firewalls) from multiple resources.\n\nSupported resources:\n- [Servers](#tag/servers) (with a public network interface)\n\nA [Firewall](#tag/firewalls) is removed from a resource once the related [Action](#tag/actions) with command `remove_firewall` successfully finished.\n\n#### Operation specific errors\n\n| Status | Code | Description |\n| --- | --- | --- |\n| `404` | `firewall_resource_not_found` | The resource the [Firewall](#tag/firewalls) should be removed from was not fou" }, { "info": { "name": "Set Rules", "type": "http" }, "http": { "method": "POST", "url": "https://api.hetzner.cloud/v1/firewalls/:id/actions/set_rules", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Firewall." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Set the rules of a [Firewall](#tag/firewalls).\n\nOverwrites the existing rules with the given ones. Pass an empty array to remove all rules.\n\nRules are limited to 50 entries per [Firewall](#tag/firewalls) and [500 effective rules](https://docs.hetzner.com/cloud/firewalls/overview#limits).\n" }, { "info": { "name": "Get an Action for a Firewall", "type": "http" }, "http": { "method": "GET", "url": "https://api.hetzner.cloud/v1/firewalls/:id/actions/:action_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the Firewall." }, { "name": "action_id", "value": "", "type": "path", "description": "ID of the Action." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "**Deprecated**: This operation is deprecated, see our [changelog](https://docs.hetzner.cloud/changelog#2026-04-30-deprecate-get-resource-action-endpoints) for more details.\n\nReturns a specific [Action](#tag/actions) for a [Firewall](#tag/firewalls).\n" } ] } ], "bundled": true }