Firewalls

List firewalls

Retrieves a list of existing firewalls and their details, including the security rules they contain and information about the virtual machines to which they are attached. For more information about the firewalls features offered by Hyperstack, see Security groups.

get/core/firewalls

Request

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

Query parameters

pageinteger

Page number to retrieve.

pageSizeinteger

Number of items to return per page.

searchstring

Filter results by case-insensitive substring match against the resource name.

environmentstring

Filter Environment ID or Name

Response

Success

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

pageinteger nullable

1-indexed page number of the current result set.

page_sizeinteger nullable

Number of items per page in the current result set.

countinteger

Number of items returned in the current page.

Example response

{
  "status": true,
  "message": "Getting firewalls success",
  "count": 2,
  "firewalls": [
    {
      "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.