firewalls

Creates, updates, deletes, gets or lists a firewalls resource.

Overview

Name	firewalls
Type	Resource
Id	digitalocean.droplets.firewalls

Fields

Name	Datatype	Description
id	string	A unique ID that can be used to identify and reference a firewall.
name	string	A human-readable name for a firewall. The name must begin with an alphanumeric character. Subsequent characters must either be alphanumeric characters, a period (.), or a dash (-).
created_at	string	A time value given in ISO8601 combined date and time format that represents when the firewall was created.
droplet_ids	array	An array containing the IDs of the Droplets assigned to the firewall.
inbound_rules	array
outbound_rules	array
pending_changes	array	An array of objects each containing the fields "droplet_id", "removing", and "status". It is provided to detail exactly which Droplets are having their security policies updated. When empty, all changes have been successfully applied.
status	string	A status string indicating the current state of the firewall. This can be "waiting", "succeeded", or "failed".
tags	array	An array containing the names of the Tags assigned to the firewall.

Methods

Name	Accessible by	Required Params	Description
droplets_list_firewalls	SELECT	droplet_id	To retrieve a list of all firewalls available to a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/firewalls The response will be a JSON object that has a key called firewalls. This will be set to an array of firewall objects, each of which contain the standard firewall attributes.

SELECT examples

To retrieve a list of all firewalls available to a Droplet, send a GET request to /v2/droplets/$DROPLET_ID/firewalls The response will be a JSON object that has a key called firewalls. This will be set to an array of firewall objects, each of which contain the standard firewall attributes.

SELECT
id,
name,
created_at,
droplet_ids,
inbound_rules,
outbound_rules,
pending_changes,
status,
tags
FROM digitalocean.droplets.firewalls
WHERE droplet_id = '{{ droplet_id }}';