Skip to navigation

List firewall group attachments

Lists the VMs a firewall group is applied to. Requires scope: firewall.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# FIREWALL_GROUP_ID: Firewall group ID
curl "https://api.ibee.ai/v1/networking/firewall-groups/$FIREWALL_GROUP_ID/attachments?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

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_idstringRequired
Firewall group ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

limitintegerOptional1-200Defaults to 50
Maximum number of records to return.
skipintegerOptional>=0Defaults to 0
Number of items to skip before the first returned item. Default 0.

Response

Firewall attachments returned successfully.
network_idstring
ID of the VM network record the group is attached to.
vm_idstring
ID of the VM.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found 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