---
title: "Returns a list of eligible firewalls for a given tenantId (productgroupId). When called with callerService=CSE and a valid system API-key"
method: GET
path: "/api/hgms/get-firewalls"
tags: ["General"]
---

# Returns a list of eligible firewalls for a given tenantId (productgroupId). When called with callerService=CSE and a valid system API-key

`GET /api/hgms/get-firewalls`

Returns a list of eligible firewalls for a given tenantId (productgroupId) when called with callerService=CSE and a valid system API key passed via header.

**Required Headers:**
- Content-Type: application/json
- X-API-KEY: System API Key (code)
- API-USERNAME: API Username (e.g., BHUVAN)
- Authorization: Bearer <token>

## Query parameters

- `userName` string
- `productgroupid` string
- `callerService` string

## Response `200`

Success

- GetHGMSFirewallsResponse
  - `content` GetHGMSFirewallsRes
    - `buyOptions` BuyOptions[], nullable
      - `serviceId` string, nullable
      - `serviceName` string, nullable
      - `isFromHes` string, nullable
      - `ssipn` string, nullable
    - `licenseCount` string, nullable
    - `rows` FirewallRows[], nullable
      - `friendlyName` string, nullable
      - `serialNumber` string, nullable
      - `model` string, nullable
      - `tenantId` string, nullable
      - `tenantName` string, nullable
      - `instance` string, nullable
      - `management` string, nullable
      - `managementicon` string, nullable
      - `managementtooltip` string, nullable
      - `workFlow` string, nullable
      - `reporting` string, nullable
      - `reportingicon` string, nullable
      - `reportingtooltip` string, nullable
      - `analytics` string, nullable
      - `analyticsicon` string, nullable
      - `analyticstooltip` string, nullable
      - `CAS` string, nullable
      - `CASicon` string, nullable
      - `CAStooltip` string, nullable
      - `captureClient` string, nullable
      - `firmwareVersion` string, nullable
      - `generation` string, nullable
      - `version` string, nullable
      - `firewallConnectorStatus` string, nullable
      - `licenseExpired` boolean, nullable
      - `licenseExpiryCnt` integer, nullable
      - `HAType` string, nullable
      - `associationType` string, nullable
      - `MDR` string, nullable
      - `captureClienticon` string, nullable
      - `captureClientooltip` string, nullable
      - `istry` boolean, nullable
      - `isActivate` boolean, nullable
      - `isBuyNow` boolean, nullable
      - `dtworkFlow` string, nullable
      - `dtmanagement` string, nullable
      - `dtreporting` string, nullable
      - `dtanalytics` string, nullable
      - `dtanalyticsOnly` string, nullable
      - `dtCAS` string, nullable
      - `dtCaptureClient` string, nullable
      - `wificloud` string, nullable
      - `dtwificloud` string, nullable
      - `cloudemail` string, nullable
      - `dtcloudemail` string, nullable
      - `cloudemailicon` string, nullable
      - `cloudemailtooltip` string, nullable
      - `wirelessicon` string, nullable
      - `wirelesstooltip` string, nullable
      - `dtWaf` string, nullable
      - `dtCaptureATP` string, nullable
      - `dtIDP` string, nullable
      - `cc_tenantid` string, nullable
      - `mdr_tenantid` string, nullable
      - `typeCaptureClient` string, nullable
      - `typeWificloud` string, nullable
      - `dtCASB` string, nullable
      - `CASB` string, nullable
      - `api_url` string, nullable
      - `api_key` string, nullable
      - `ccNodeCount` string, nullable
      - `MDRNodeCount` string, nullable
      - `ccIsLsg` boolean
      - `countryCode` string, nullable
      - `isNFR` string, nullable
      - `dataCenter` string, nullable
      - `managementOption` string, nullable
      - `cfs5` Cfs5
        - `dnsDomain` string, nullable
        - `webcfsDomain` string, nullable
        - `webcfs2Domain` string, nullable
      - `dnsDomain` string, nullable
      - `webcfsDomain` string, nullable
      - `webcfs2Domain` string, nullable
      - `ccdcid` string, nullable
  - `operationStatus` string, nullable
  - `msgCode` string, nullable
  - `msgId` string, nullable
  - `msgDesc` string, nullable

---

[API](https://skmtc.dev/mysonicwall/apis/restapi-core-v1.md) · [All operations](https://skmtc.dev/mysonicwall/apis/restapi-core-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mysonicwall/restapi-core-v1/revisions/ddffed195eba/schema)