List firewall groups
Lists one page of the firewall groups in a workspace: 10 by default, at most 100 per page. Use limit and offset to page through the rest. Requires scope: firewall.read.
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.
Query parameters
workspace_id
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
limit
Maximum number of records to return. The server returns 10 when this is omitted; use offset to read further pages.
offset
Number of records to skip before the first one returned.
Response
Firewall groups returned 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
401
Unauthorized Error
403
Forbidden Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error
