Logo

Command Palette

Search for a command to run...

Firewall rules define network access controls for your servers. They specify which IP addresses, servers, or server groups can communicate on specific ports and protocols.

Model
idinteger

The unique identifier of the firewall rule.

from_ipstring

The source IP address or CIDR block that traffic originates from.

from_group_idinteger

The ID of the source server group that traffic originates from.

from_server_idstring

The UID of the source server that traffic originates from.

to_ipstring

The destination IP address or CIDR block that traffic is directed to.

to_group_idinteger

The ID of the destination server group that traffic is directed to.

to_server_idstring

The UID of the destination server that traffic is directed to.

protocolstring

The network protocol for this rule (tcp, udp, or icmp).

portstring

The port or port range for this rule (e.g., "80", "443", "8000-8999").

rule_typestring

The type of firewall rule (static, dynamic, or user).

commentsstring

Optional comments or description for this firewall rule.

created_atdatetime

The date and time the firewall rule was created, in ISO 8601 format.

updated_atdatetime

The date and time the firewall rule was last updated, in ISO 8601 format.

Example

{
  "id": 789,
  "from_ip": "192.168.1.0/24",
  "from_group_id": null,
  "from_server_id": null,
  "to_ip": null,
  "to_group_id": 123,
  "to_server_id": null,
  "protocol": "tcp",
  "port": "443",
  "rule_type": "user",
  "comments": "Allow HTTPS traffic from office network",
  "created_at": "2024-01-20T09:15:00Z",
  "updated_at": "2024-02-10T16:30:00Z"
}