Skip to main content

FirewallDetailFields

idinteger

Unique numeric identifier for the firewall.

Example: 9876
namestring

Name of the firewall.

Example: example-firewall
descriptionstring

Description of the firewall.

Example: example
environment object

Environment the firewall is deployed in.

idinteger

Unique numeric identifier for the environment.

Example: 2058
namestring

Name of the environment.

Example: example-environment
regionstring

Region the environment is in: CANADA-1, NORWAY-1, or US-1.

Example: NORWAY-1
statusstring

Current status of the firewall.

Example: SUCCESS
created_atstring<date-time>

ISO 8601 UTC timestamp marking when the firewall was created.

Example: 2026-05-07T09:21:55Z
rules object[]

Firewall rules, each entry defines a direction, protocol, and remote IP range.

  • Array [
  • idinteger

    Unique numeric identifier for the firewall rule.

    Example: 7613
    directionstring

    Direction of traffic the rule applies to, ingress or egress.

    Example: egress
    protocolstring

    Protocol, one of tcp, udp, icmp, or any.

    Example: any
    port_range_mininteger

    Lower bound (inclusive) of the port range the rule applies to.

    Example: 1
    port_range_maxinteger

    Upper bound (inclusive) of the port range the rule applies to.

    Example: 65535
    ethertypestring

    Internet Protocol version, IPv4 or IPv6.

    Example: IPv4
    remote_ip_prefixstring

    CIDR block the rule applies to.

    Example: 0.0.0.0/0
    statusstring

    Status of the firewall rule.

    Example: SUCCESS
    created_atstring<date-time>

    ISO 8601 UTC timestamp marking when the firewall rule was created.

    Example: 2026-05-06T15:18:42Z
  • ]
  • attachments object[]

    Virtual machines the firewall is attached to.

  • Array [
  • idinteger

    Unique numeric identifier for the firewall attachment.

    statusstring

    Status of the firewall attachment.

    vm object

    Virtual machine the firewall is attached to.

    idinteger

    Unique numeric identifier for the virtual machine.

    namestring

    Name of the virtual machine.

    flavorstring

    Flavor (hardware configuration) of the virtual machine.

    environmentstring

    Name of the environment the virtual machine is deployed in.

    statusstring

    Current status of the virtual machine.

    created_atstring<date-time>

    ISO 8601 UTC timestamp marking when the virtual machine was created.

    created_atstring<date-time>

    ISO 8601 UTC timestamp marking when the firewall was attached to the virtual machine.

  • ]
  • FirewallDetailFields
    {
    "id": 9876,
    "name": "example-firewall",
    "description": "example",
    "environment": {
    "id": 2058,
    "name": "example-environment",
    "region": "NORWAY-1"
    },
    "status": "SUCCESS",
    "created_at": "2026-05-07T09:21:55Z",
    "rules": [
    {
    "id": 7613,
    "direction": "egress",
    "protocol": "any",
    "port_range_min": 1,
    "port_range_max": 65535,
    "ethertype": "IPv4",
    "remote_ip_prefix": "0.0.0.0/0",
    "status": "SUCCESS",
    "created_at": "2026-05-06T15:18:42Z"
    }
    ],
    "attachments": [
    {
    "id": 0,
    "status": "string",
    "vm": {
    "id": 0,
    "name": "string",
    "flavor": "string",
    "environment": "string",
    "status": "string",
    "created_at": "2024-07-29T15:51:28.071Z"
    },
    "created_at": "2024-07-29T15:51:28.071Z"
    }
    ]
    }