Get List of All Device Groups (EA)

Retrieves all device groups available in the system.

Note: This endpoint is currently in Early Availability.

Resource name: /api/v1/groups

Request Method: GET

Request Parameters:

This API does not accept any query or body parameters.

cURL Example:

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

Status Codes:

Code Description
200 List of all groups retrieved successfully
400 Bad Request
401 Unauthorized
403 User does not have permission to view groups
404 Not Found
423 Locked
429 Too Many Requests
500 Internal Server Error
503 Service Unavailable

Response Parameters:

Parameter Type Description
displayName string Name of the group displayed
entityType string Type of the entity
firewalls array of strings List of associated firewall display names
name string Internal name of the group

Response Example Success 200:

Copy 
  [
  {
    "entityType": "GROUP",
    "name": "group_a",
    "displayName": "group_a",
    "firewalls": [
      {
        "entityType": "FW_PIX",
        "name": "s_144_5_136_6_1",
        "displayName": "s_144_5_136_6_1"
      }
    ]
  }
]

Response Example Failure 400:

Copy 
{
  "error": "string",
  "description": "string",
  "fieldErrors": [
    {
      "field": "string",
      "error": "string"
    }
  ]
}