Skip to content
Docs

Firewall Rules

Create Firewall Rule
POST/v1/networking/vpcs/{vpc_id}/firewall_rules
Firewall Rule Details
GET/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}
Update Firewall Rule
PATCH/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}
Delete Firewall Rule
DELETE/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}
List Firewall Rules
GET/v1/networking/vpcs/{vpc_id}/firewall_rules
ModelsExpand Collapse
FirewallRule object { id, created_at, destination_address, 8 more }

Firewall rule details.

id: string

Unique identifier for the Firewall Rule.

created_at: string

When the Firewall Rule was created.

formatdate-time
destination_address: string

Destination address of the Firewall Rule. Either VPC CIDR or VM in VPC.

destination_ports: array of string

Destination ports of the Firewall Rule.

name: string

Name of the Firewall Rule.

protocol: "tcp" or "udp"

Protocol of the Firewall Rule.

One of the following:
"tcp"
"udp"
source_address: string

Source address of the Firewall Rule. Address of 0.0.0.0 requires a CIDR mask of 0.

Status of the resource.

One of the following:
"pending"
"creating"
"updating"
"ready"
"deleting"
"deleted"
"error"
tags: array of string

Tags to attach to the Firewall Rule.

updated_at: string

When the Firewall Rule was updated.

formatdate-time
vpc_id: string

ID of the VPC the Firewall Rule belongs to.

FirewallRuleList object { items, pagination }
items: array of FirewallRule { id, created_at, destination_address, 8 more }
id: string

Unique identifier for the Firewall Rule.

created_at: string

When the Firewall Rule was created.

formatdate-time
destination_address: string

Destination address of the Firewall Rule. Either VPC CIDR or VM in VPC.

destination_ports: array of string

Destination ports of the Firewall Rule.

name: string

Name of the Firewall Rule.

protocol: "tcp" or "udp"

Protocol of the Firewall Rule.

One of the following:
"tcp"
"udp"
source_address: string

Source address of the Firewall Rule. Address of 0.0.0.0 requires a CIDR mask of 0.

Status of the resource.

One of the following:
"pending"
"creating"
"updating"
"ready"
"deleting"
"deleted"
"error"
tags: array of string

Tags to attach to the Firewall Rule.

updated_at: string

When the Firewall Rule was updated.

formatdate-time
vpc_id: string

ID of the VPC the Firewall Rule belongs to.