Firewalls
Operations for managing virtual machine firewalls.
| Endpoint Name | URL | Description |
|---|---|---|
| List firewalls | GET /core/firewalls | Returns a list of your existing firewalls. |
| Retrieve firewall details | GET /core/firewalls/{id} | Retrieves the details for a firewall. |
| Create firewall | POST /core/firewalls | Creates a firewall. |
| Delete firewall | DELETE /core/firewalls/{id} | Deletes a firewall. |
| Add firewall rule to firewall | POST /core/firewalls/{firewall_id}/firewall-rules | Adds firewall rules to a firewall. |
| Remove firewall rule from firewall | DELETE /core/firewalls/{firewall_id}/firewall-rules/{firewall_rule_id} | Deletes a firewall rule from a firewall. |
| Attach firewall to virtual machines | POST /core/firewalls/{firewall_id}/update-attachments | Attaches a firewall to one or more virtual machines. |
The firewall object
Firewall endpoints return the firewall object or an array of firewalls objects, providing detailed information about your virtual machine firewalls. This information includes the name, ID, description, environment, creation timestamp, the configuration of each firewall rule, and the details of the virtual machines to which they are attached.
Attributes of the Firewall object
id integer
The unique identifier for the firewall.
name string
The name of the firewall.
description string
A description of the firewall.
environment object
An object containing information about the environment in which the firewall is deployed.
Show child attributes
status string
The status of the firewall (e.g., "SUCCESS").
created_at date-time
The timestamp when the firewall was created.
rules array of objects
An array containing firewall rule objects.
Show child attributes
id integer
The unique identifier for the firewall rule.
direction string
The direction of the firewall rule (e.g., "egress", "ingress").
protocol string
The protocol associated with the firewall rule.
port_range_min integer
The minimum port range for the firewall rule.
port_range_max integer
The maximum port range for the firewall rule.
ethertype string
The Ethernet type for the firewall rule (e.g., "IPv4", "IPv6").
remote_ip_prefix string
The remote IP prefix associated with the firewall rule.
status string
The status of the firewall rule (e.g., "SUCCESS").
created_at date-time
The timestamp when the firewall rule was created.
attachments array of objects
An array containing information about firewall attachments to virtual machines.
Show child attributes
id integer
The unique identifier for the attachment of the firewall to the VM.
status string
The status of the firewall attachment (e.g., "SUCCESS").
vm object
An object containing details about the virtual machine that the firewall is attached to.
Show child attributes
id integer
The unique identifier for the virtual machine.
name string
The name of the virtual machine.
flavor string
The flavor (hardware configuration) of the virtual machine.
environment string
The environment in which the virtual machine is deployed.
status string
The status of the virtual machine (e.g., "HIBERNATED").
created_at date-time
The timestamp when the virtual machine was created.
created_at date-time
The timestamp when the firewall was attached to the VM.
{
"id": 10,
"name": "firewall",
"description": "test firewall",
"environment": {
"id": 1281,
"name": "testenv1",
"region": "NORWAY-1"
},
"status": "SUCCESS",
"created_at": "2024-01-17T11:09:33",
"rules": [
{
"id": 36660,
"direction": "egress",
"protocol": "any",
"port_range_min": 1,
"port_range_max": 65535,
"ethertype": "IPv6",
"remote_ip_prefix": "0.0.0.0/0",
"status": "SUCCESS",
"created_at": "2024-01-17T11:09:37"
},
{...}
],
"attachments": [
{
"id": 1,
"status": "SUCCESS",
"vm": {
"id": 1,
"name": "example-vm",
"flavor": "s",
"environment": "test-env",
"status": "HIBERNATED",
"created_at": "1970-01-01T00:00:00.000Z"
},
"created_at": "1970-01-01T00:00:00.000Z"
}
]
}