List firewall groups and rules

Retrieve all firewall groups associated with your account, including system-generated and custom groups. See the number of rules linked to each group.

VPS Services Firewall

Context

Related endpoints

POST /api/firewall-groups Create firewall groups and rules GET /api/firewall-groups/{id} Get firewall group details PUT /api/firewall-groups/{id} Update firewall rules for a firewall group

Headers

Accept Example

Content-Type Example

Responses

200

data object required

data.groups array<object> required · Example: [{"id":"2c1b4464-12a6-40bd-ad53-53a348fb36fd","client_id":30000,"name":"ssh-home","desc...

data.groups[].client_id integer required · Example: 30000

data.groups[].created_at string required · Example: 2026-02-10T00:00:00.000Z

data.groups[].description string · nullable required · Example: ssh hemma och web

Nullable: may be null when not applicable.

data.groups[].id string required · Example: 2c1b4464-12a6-40bd-ad53-53a348fb36fd

data.groups[].is_system boolean required · Example: false

data.groups[].name string required · Example: ssh-home

data.groups[].rules_count integer required · Example: 1

data.groups[].updated_at string required · Example: 2026-02-10T00:00:00.000Z

requestId string required · Example: 2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba

Unique request identifier (UUID).

success boolean required · Example: true

True for successful responses.

timestamp string required · Example: 2026-02-10T00:00:00.000Z

ISO 8601 timestamp (UTC).

GET https://cloud.hostup.se/api/firewall-groups

For AI assistants

cURL

curl -X GET "https://cloud.hostup.se/api/firewall-groups" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "success": true,
  "timestamp": "2026-02-10T00:00:00.000Z",
  "requestId": "2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba",
  "data": {
    "groups": []
  }
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "groups": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "client_id": {
                "type": "integer"
              },
              "created_at": {
                "type": "string"
              },
              "description": {
                "type": "string",
                "nullable": true
              },
              "id": {
                "type": "string"
              },
              "is_system": {
                "type": "boolean"
              },
              "name": {
                "type": "string"
              },
              "rules_count": {
                "type": "integer"
              },
              "updated_at": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "requestId": {
      "type": "string",
      "description": "Unique request identifier (UUID)."
    },
    "success": {
      "type": "boolean",
      "description": "True for successful responses."
    },
    "timestamp": {
      "type": "string",
      "description": "ISO 8601 timestamp (UTC)."
    }
  }
}