Firewall Rule

Ingress firewall rules on a public IP.

Resource base path: /restapi/firewallrule

Method	Path	Description
POST	/restapi/firewallrule/createFirewallRule	Create Firewall Rule
GET	/restapi/firewallrule/firewallRuleList	Firewall Rule List
DELETE	/restapi/firewallrule/deleteFirewallRule/{uuid}	Delete Firewall Rule

note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.

---

Create Firewall Rule

Create Firewall Rule.

POST /restapi/firewallrule/createFirewallRule

Request body

Field	Type	Required	Description
startPort	string	No	First port in the range.
ipAddressUuid	string	No	UUID of the public IP address.
icmpType	string	No
protocol	string	✅ Yes	FirewallRule protocol (TCP, UDP,ICMP) Example: TCP
cidrList	string	No	CIDR range the rule applies to (for example, 0.0.0.0/0).
icmpCode	string	No
endPort	string	No	Last port in the range.

{
  "startPort": "8080",
  "ipAddressUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "icmpType": "string",
  "protocol": "TCP",
  "cidrList": "0.0.0.0/0",
  "icmpCode": "string",
  "endPort": "8080"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/firewallrule/createFirewallRule" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "startPort": "8080",
  "ipAddressUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "icmpType": "string",
  "protocol": "TCP",
  "cidrList": "0.0.0.0/0",
  "icmpCode": "string",
  "endPort": "8080"
}'

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listFirewallRuleResponse": [
    {
      "startPort": "8080",
      "ipAddressUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "icmpType": "string",
      "protocol": "TCP",
      "cidrList": "0.0.0.0/0",
      "icmpCode": "string",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "endPort": "8080",
      "status": "Active"
    }
  ]
}

---

Firewall Rule List

Firewall Rule List.

GET /restapi/firewallrule/firewallRuleList

Parameters

Parameter	In	Type	Required	Description
zoneUuid	query	string	✅ Yes	UUID of the zone the resource belongs to.
uuid	query	string	No	UUID of the resource.
ipAddressUuid	query	string	No	UUID of the public IP address.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/firewallrule/firewallRuleList?zoneUuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listFirewallRuleResponse": [
    {
      "startPort": "8080",
      "ipAddressUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "icmpType": "string",
      "protocol": "TCP",
      "cidrList": "0.0.0.0/0",
      "icmpCode": "string",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "endPort": "8080",
      "status": "Active"
    }
  ]
}

---

Delete Firewall Rule

Delete Firewall Rule.

DELETE /restapi/firewallrule/deleteFirewallRule/{uuid}

Parameters

Parameter	In	Type	Required	Description
uuid	path	string	✅ Yes	UUID of the resource.

Example request

curl -X DELETE \
  "https://portal.your-domain.com/restapi/firewallrule/deleteFirewallRule/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

true