Skip to navigation

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.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
curl -X POST "https://api.ibee.ai/v1/networking/firewall-groups?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "<name>"}'

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-KeystringOptionalformat: "^[!-~]{1,256}$"1-256 characters

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_progress with Retry-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_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.

Request

This endpoint expects an object.
namestringRequired1-120 characters
Display name of the group.
descriptionstring or nullOptional
Optional description.
is_defaultbooleanOptionalDefaults to false
Mark the group as the workspace's default group. Default false.

Response

Firewall group created successfully.
firewall_group_idstring
Unique ID of the group.
organization_idstring
ID of the owning organization.
workspace_idstring
ID of the owning workspace.
namestring
Display name of the group.
is_defaultboolean
Whether this is the workspace's default group.
statusstring

Status of the group; active when usable.

ruleslist of objects
Rules in the group.
created_atdatetime

When the resource was created (ISO 8601).

updated_atdatetime

When the resource was last changed (ISO 8601).

workspace_namestringOptional
Display name of the workspace.
descriptionstring or nullOptional
Description of the group.
linked_instance_countintegerOptional>=0
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