Get a firewall group

GET

/networking/firewall-groups/:firewall_group_id

GET

/v1/networking/firewall-groups/:firewall_group_id

$ curl -G https://api.ibee.ai/v1/networking/firewall-groups/firewall_group_id \
>      -H "Authorization: Bearer <token>" \
>      -d workspace_id=710995

1 {
2   "firewall_group_id": "string",
3   "organization_id": "string",
4   "workspace_id": "string",
5   "name": "string",
6   "is_default": true,
7   "status": "string",
8   "rules": [
9     {
10       "direction": "ingress",
11       "protocol": "tcp",
12       "action": "allow",
13       "rule_id": "string",
14       "enabled": true,
15       "system_managed": true,
16       "created_at": "2024-01-15T09:30:00Z",
17       "updated_at": "2024-01-15T09:30:00Z",
18       "description": "string",
19       "port_start": 1,
20       "port_end": 1,
21       "remote_targets": [
22         "string"
23       ],
24       "priority": 1
25     }
26   ],
27   "created_at": "2024-01-15T09:30:00Z",
28   "updated_at": "2024-01-15T09:30:00Z",
29   "workspace_name": "string",
30   "description": "string",
31   "linked_instance_count": 1
32 }

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.

Response

Firewall group returned successfully.

firewall_group_idstring

organization_idstring

workspace_idstring

namestring

is_defaultboolean

statusstring

ruleslist of objects

created_atdatetime

updated_atdatetime

workspace_namestringOptional

descriptionstring or nullOptional

linked_instance_countintegerOptional>=0

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error