firewall_rules
Creates, updates, deletes, gets or lists a firewall_rules
resource.
Overview
Name | firewall_rules |
Type | Resource |
Id | digitalocean.compute.firewall_rules |
Fields
The following fields are returned by SELECT
queries:
SELECT
not supported for this resource, use SHOW METHODS
to view available operations for the resource.
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
firewalls_add_rules | insert | firewall_id | To add additional access rules to a firewall, send a POST request to/v2/firewalls/$FIREWALL_ID/rules . The body of the request may include aninbound_rules and/or outbound_rules attribute containing an array of rules to be added. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. | |
firewalls_delete_rules | delete | firewall_id | To remove access rules from a firewall, send a DELETE request to/v2/firewalls/$FIREWALL_ID/rules . The body of the request may include aninbound_rules and/or outbound_rules attribute containing an array of rulesto be removed. No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
firewall_id | string (uuid) | A unique ID that can be used to identify and reference a firewall. (example: bb4b2611-3d72-467b-8602-280330ecd65c) |
INSERT
examples
- firewalls_add_rules
- Manifest
To add additional access rules to a firewall, send a POST request to/v2/firewalls/$FIREWALL_ID/rules
. The body of the request may include an
inbound_rules and/or outbound_rules attribute containing an array of rules to
be added.
No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
INSERT INTO digitalocean.compute.firewall_rules (
data__inbound_rules,
data__outbound_rules,
firewall_id
)
SELECT
'{{ inbound_rules }}',
'{{ outbound_rules }}',
'{{ firewall_id }}'
;
# Description fields are for documentation purposes
- name: firewall_rules
props:
- name: firewall_id
value: string (uuid)
description: Required parameter for the firewall_rules resource.
- name: inbound_rules
value: array
- name: outbound_rules
value: array
DELETE
examples
- firewalls_delete_rules
To remove access rules from a firewall, send a DELETE request to/v2/firewalls/$FIREWALL_ID/rules
. The body of the request may include aninbound_rules
and/or outbound_rules
attribute containing an array of rules
to be removed.
No response body will be sent back, but the response code will indicate
success. Specifically, the response code will be a 204, which means that the
action was successful with no returned body data.
DELETE FROM digitalocean.compute.firewall_rules
WHERE firewall_id = '{{ firewall_id }}' --required;