Get Groups by Device Display Name (EA)

Retrieves the groups associated with one or more devices, based on their display names. This endpoint allows users to identify group membership for specific devices configured in the system.

Note: This endpoint is currently in Early Availability.

Resource name: /api/v1/groups/devices/{deviceDisplayName}

Request Method: GET

Request parameters

ParameterTypeDescription
deviceDisplayNamestringOne or more device display names (comma-separated). Use the GET /devices method from the Devices Setup Resource Group to get device display names.

cUrl Example

Copy
curl -X GET "https://<localhost>/api/v1/groups/devices/firewall123" \
    -H 'accept: */*'

Status codes

CodeDescription
200Groups retrieved successfully
400Bad Request – Invalid device name format
401Unauthorized – Authentication required
403Forbidden – Access denied for the requested resource
404Device not found
423Locked – The resource is currently locked
429Too Many Requests – Rate limit exceeded
500Internal Server Error
503Service Unavailable

Response parameters

ParameterTypeDescription
entityTypestringType of the entity (e.g., "firewall")
namestringInternal identifier of the group or device
displayNamestringUser-visible name of the group or device
firewallsarrayNested list of devices associated with the group

Response example success 200

Copy
[
  {
    "entityType": "group",
    "name": "branchGroup",
    "displayName": "Branch Firewalls",
    "firewalls": [
      {
        "entityType": "firewall",
        "name": "fw01",
        "displayName": "Branch A"
      },
      {
        "entityType": "firewall",
        "name": "fw02",
        "displayName": "Branch B"
      }
    ]
  }
]

Response example failure 400

Copy
{
  "error": "Invalid device name format",
  "description": "Please provide valid device display names separated by commas."
}