Add Devices to a Group (EA)

Attaches one or more existing firewalls (by displayName) to a previously created group, identified by its groupDisplayName. Requires admin permissions to run this API.

Note: This endpoint is currently in Early Availability.

Resource name: /api/v1/groups/{groupDisplayName}/addDevices

Request Method: POST

Request parameters

Parameter Type Location Description
groupDisplayName string path Case-sensitive display name of the target group.
body array JSON body List of firewall displayName values to add. Use the GET /devices method from the Devices Setup Resource Group to get device display names.

Request example

Copy 
[
  "FW-CHI-01",
  "FW-NYC-02"
]        

cUrl Example

Copy 
curl -X POST "https://<localhost>/api/v1/groups/MyGroup/addDevices" \
  -H 'Cookie: PHPSESSID=5f1a3je95qqrn5fj0k3hhv7foc' \
  -H 'accept: */*' \
  -H "Content-Type: application/json" \
  -d '["FW-CHI-01","FW-NYC-02"]'        

Status codes

Code Description
200 Devices added successfully.
400 Invalid device names provided.
401 Unauthorized – bad/expired credentials.
403 Caller lacks permission to modify the group.
404 Group not found.
423 Locked – another operation is in progress.
429 Too many requests (rate-limit hit).
500 Internal server error.
503 Service unavailable.

Response parameters

Name Type Description
ApiFailure object Returned on 4xx/5xx errors.
error string Error code.
description string Human-readable explanation.
fieldErrors arrayFieldError Field-specific validation issues.
FieldError object Validation detail.
field string Parameter name.
error string Validation message.
ExternalAPIErrorResponse object Returned when authentication via external API fails.
status boolean false on error.
message string Error description.

Response example success 200

Copy 
"Devices added successfully"                

Response example failure 400

Copy 
{
  "error": "Invalid device names provided",
  "description": "Some devices do not exist: FW-XYZ",
  "fieldErrors": [
    {
      "field": "deviceDisplayNames",
      "error": "FW-XYZ not found"
    }
  ]
}