Firewalls

Retrieve firewall details

Retrieves details on an existing firewall, including the firewall rules it contains and information about the virtual machines to which it is attached.

get/core/firewalls/{id}

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/firewalls/{id}
  • Auth: API key in header api_key

Path parameters

idinteger required

ID of the firewall.

Response

Success

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

Example response

{
  "status": true,
  "message": "Getting Firewall Details Successful.",
  "firewall": {
    "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"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.