firewall_tags
Creates, updates, deletes, gets or lists a firewall_tags
resource.
Overview
Name | firewall_tags |
Type | Resource |
Id | digitalocean.compute.firewall_tags |
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_tags | insert | firewall_id , data__tags | To assign a tag representing a group of Droplets to a firewall, send a POST request to /v2/firewalls/$FIREWALL_ID/tags . In the body of the request,there should be a tags attribute containing a list of tag names.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_tags | delete | firewall_id | To remove a tag representing a group of Droplets from a firewall, send a DELETE request to /v2/firewalls/$FIREWALL_ID/tags . In the body of therequest, there should be a tags attribute containing a list of tag names.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_tags
- Manifest
To assign a tag representing a group of Droplets to a firewall, send a POST
request to /v2/firewalls/$FIREWALL_ID/tags
. In the body of the request,
there should be a tags
attribute containing a list of tag names.
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_tags (
data__tags,
firewall_id
)
SELECT
'{{ tags }}' --required,
'{{ firewall_id }}'
;
# Description fields are for documentation purposes
- name: firewall_tags
props:
- name: firewall_id
value: string (uuid)
description: Required parameter for the firewall_tags resource.
- name: tags
value: array
description: >
A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request. <br><br>Requires `tag:create` and `tag:read` scopes.
DELETE
examples
- firewalls_delete_tags
To remove a tag representing a group of Droplets from a firewall, send a
DELETE request to /v2/firewalls/$FIREWALL_ID/tags
. In the body of the
request, there should be a tags
attribute containing a list of tag names.
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_tags
WHERE firewall_id = '{{ firewall_id }}' --required;