Create a firewall group
Creates a firewall group, a reusable set of inbound and outbound rules you can apply to VMs. 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.
Headers
X-Idempotency-Key
Retry key for this create. Send the same key and the same body on every retry. The key is scoped to organization, workspace and path.
- Create completed: you get the original answer for 24 hours, even if the plan limit has since been reached.
- Refused or never sent: nothing was created, so the key is free to use again, including with a corrected body.
- Unknown outcome (timeout, server error, lost connection): 409
idempotency_in_progresswithRetry-After. This usually lasts 30 seconds and at most 3 minutes. Keep retrying with the same key and body. The next retry returns the Reserved IP, subnet or NAT gateway. For a VPC, firewall group or port forward, it either creates the resource or answers 409 “already exists”. - Changed body, while the outcome is unresolved or after the create completed: 409
idempotency_conflict. - New key at the plan limit: 402.
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.
name
Display name of the group.
description
Optional description.
is_default
Mark the group as the workspace's default group. Default false.
Response
Firewall group created 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
409
Conflict 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
