firewalls

Overview

Name	firewalls
Type	Resource
Id	linode.networking.firewalls

Fields

Name	Datatype	Description
id	integer	The Firewall's unique ID.
created	string	When this Firewall was created.
label	string	The Firewall's label, for display purposes only. Firewall labels have the following constraints: Must begin and end with an alphanumeric character. May only consist of alphanumeric characters, dashes (-), underscores (_) or periods (.). Cannot have two dashes (--), underscores (__) or periods (..) in a row. Must be between 3 and 32 characters. * Must be unique.
rules	object	The inbound and outbound access rules to apply to the Firewall. A Firewall may have up to 25 rules across its inbound and outbound rulesets.
status	string	The status of this Firewall. When a Firewall is first created its status is enabled. Use the Update Firewall endpoint to set a Firewall's status to enabled or disabled. * Use the Delete Firewall endpoint to delete a Firewall.
tags	array	An array of tags applied to this object. Tags are for organizational purposes only.
updated	string	When this Firewall was last updated.

Methods

Name	Accessible by	Required Params	Description
getFirewall	SELECT	firewallId	Get a specific Firewall resource by its ID. The Firewall's Devices will not be returned in the response. Instead, use the List Firewall Devices endpoint to review them.
getFirewalls	SELECT		Returns a paginated list of accessible Firewalls.
createFirewalls	INSERT	data__rules	Creates a Firewall to filter network traffic. Use the rules property to create inbound and outbound access rules. Use the devices property to assign the Firewall to a service and apply its Rules to the device. Requires read_write User's Grants to the device. Currently, Firewalls can only be assigned to Linode instances. A Firewall can be assigned to multiple Linode instances at a time. A Linode instance can have one active, assigned Firewall at a time. Additional disabled Firewalls can be assigned to a service, but they cannot be enabled if another active Firewall is already assigned to the same service. * A firewall_create Event is generated when this endpoint returns successfully.
deleteFirewall	DELETE	firewallId	Delete a Firewall resource by its ID. This will remove all of the Firewall's Rules from any Linode services that the Firewall was assigned to. A firewall_delete Event is generated when this endpoint returns successfully.
_getFirewall	EXEC	firewallId	Get a specific Firewall resource by its ID. The Firewall's Devices will not be returned in the response. Instead, use the List Firewall Devices endpoint to review them.
_getFirewalls	EXEC		Returns a paginated list of accessible Firewalls.
updateFirewall	EXEC	firewallId	Updates information for a Firewall. Some parts of a Firewall's configuration cannot be manipulated by this endpoint: - A Firewall's Devices cannot be set with this endpoint. Instead, use the Create Firewall Device and Delete Firewall Device endpoints to assign and remove this Firewall from Linode services. - A Firewall's Rules cannot be changed with this endpoint. Instead, use the Update Firewall Rules endpoint to update your Rules. - A Firewall's status can be set to enabled or disabled by this endpoint, but it cannot be set to deleted. Instead, use the Delete Firewall endpoint to delete a Firewall. If a Firewall's status is changed with this endpoint, a corresponding firewall_enable or firewall_disable Event will be generated.