Update a firewall rule
Changes an existing rule in a firewall group. Requires scope: firewall.write.
Authentication
AuthorizationBearer
IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.
Path parameters
firewall_group_id
Firewall group ID.
firewall_rule_id
Firewall rule ID.
Query parameters
workspace_id
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Request
This endpoint expects an object.
description
Optional description of the rule.
direction
ingress: traffic into the VM (default).egress: traffic out of the VM.
Allowed values:
protocol
tcp(default)udpicmpany: all protocols.
Allowed values:
port_start
First port of the range (1-65535). Required for tcp and udp; ignored for other protocols.
port_end
Last port of the range (1-65535). Defaults to port_start.
remote_targets
Remote IPv4 addresses or CIDRs the rule matches, for example 0.0.0.0/0.
action
allow: let matching traffic through (default).drop: discard matching traffic.
Allowed values:
priority
Evaluation priority of the rule.
enabled
Whether the rule is applied.
Response
Firewall rule updated successfully.
firewall_group_id
Unique ID of the group.
organization_id
ID of the owning organization.
workspace_id
ID of the owning workspace.
name
Display name of the group.
is_default
Whether this is the workspace's default group.
status
Status of the group; active when usable.
rules
Rules in the group.
created_at
When the resource was created (ISO 8601).
updated_at
When the resource was last changed (ISO 8601).
workspace_name
Display name of the workspace.
description
Description of the group.
linked_instance_count
Number of VMs the group is attached to.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
422
Unprocessable Entity Error
423
Locked Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error
