Add Firewall Rule to VM

Creates a firewall rule and applies it to a virtual machine. Include the virtual machine ID in the path, and provide the firewall rule configuration in the request body, as detailed below.

HTTP Request

POST {API_URL}/virtual-machines/{id}/firewall-rules

Path parameters

Parameters	Requirements	Type	Description
id	Required	string	The unique identifier of the virtual machine for which to retrieve details.

Body parameters

Parameters	Requirements	Type	Description
direction	Required	string	The direction of traffic that the firewall rule applies to. Possible values: one of inbound (incoming traffic) or outbound (outgoing traffic).
protocol	Required	string	The network protocol associated with the rule. Possible values: one of tcp or udp or icmp
ethertype	Required	string	The Ethernet type associated with the rule. Possible values: one of IPv4 or IPv6.
remote_ip_prefix	Required	string	The IP address range that is allowed to access the specified port.
port_range_min	Required	integer	The minimum port number in the range of ports to be allowed by the firewall rule. Values 1-65535 are accepted.
port_range_max	Required	integer	The maximum port number in the range of ports to be allowed by the firewall rule. Values 1-65535 are accepted.
description	Optional	string	An optional description of the firewall rule.

Reponse Attributes

status boolean

Indicates the result of the request to create firewall rule to a virtual machine. true signifies success, while false indicates an error.

message string

A description of the status of the request.

data object

Provides the firewall rule configuration that was sent in the request, along with additional information such as the time of rule creation, rule ID of the firewall rule that was created.

Each firewall rule specifies the following properties:

• direction: The direction of traffic that the firewall rule applies to. Possible values: one of inbound (incoming traffic) or outbound (outgoing traffic).
• protocol: The network protocol associated with the rule. Possible values: one of tcp or udp or icmp
• ethertype: The Ethernet type associated with the rule. Possible values: one of IPv4 or IPv6.
• remote_ip_prefix: The IP address range that is allowed to access the specified port.
• port_range_min: The minimum port number in the range of ports to be allowed by the firewall rule. Values 1-65535 are accepted.
• port_range_max: The maximum port number in the range of ports to be allowed by the firewall rule. Values 1-65535 are accepted.
• description: An optional description of the firewall rule.

Example

Request

curl -X POST '{API_URL}virtual-machines/{id}/firewall-rules' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'refresh-token: {REFRESH_TOKEN}' \
-H 'Content-Type: application/json' \
-d '{
    "direction":"inbound",
    "ethertype":"IPv4",
    "protocol":"tcp",
    "port_range_min":80,
    "port_range_max":80,
    "remote_ip_prefix":"0.0.0.0/0",
    "description":"http"
}'

Response

{
    "status": true,
    "message": "Creating firewall rule successful",
    "data": {
        "id": "6708d608702bb055a4156573",
        "direction": "inbound",
        "ethertype": "IPv4",
        "protocol": "tcp",
        "port_range_min": 80,
        "port_range_max": 80,
        "remote_ip_prefix": "0.0.0.0/0",
        "description": "http"
    }
}