Update IP Group

Endpoint

PUT /apiops/projects/{projectName}/ipGroups/{ipGroupName}/

Authentication

Requires a Personal API Access Token.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes
Content-Type	application/json	Yes

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
ipGroupName	string	Yes	IP Group name (cannot be changed)

Request Body

Full JSON Body Example

{
  "name": "AllowedIPs",
  "description": "Updated description for allowed IP addresses"
}

Request Body Fields

Field	Type	Required	Default	Description
name	string	Yes	-	IP Group name (must not be empty; should match path {ipGroupName} for consistency)
description	string	No	-	IP Group description
ipList	array[string]	No	[]	When provided and non-empty, replaces the entire IP list. When omitted or empty, clears all IPs in the group

Notes

• Path {ipGroupName} identifies the group; the name cannot be renamed via APIops
• name in the body is validated but not used to change the stored name
• Omitting ipList or sending an empty array removes all IPs — use Update IPs in Group or Add IPs to Group for IP-only changes

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "deploymentResult": {
    "success": true,
    "responseTime": 1500,
    "detailList": [
      {
        "envName": "production",
        "success": true,
        "detail": "Deployed successfully",
        "responseTime": 450
      }
    ]
  }
}

Error Response (400 Bad Request)

{
  "status": "FAILURE",
  "resultMessage": "name value can not be empty!"
}

or

{
  "status": "FAILURE",
  "resultMessage": "IP Group (AllowedIPs) is not found!"
}

cURL Example

curl -X PUT \
  "https://demo.apinizer.com/apiops/projects/MyProject/ipGroups/AllowedIPs/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "AllowedIPs",
    "description": "Updated description"
  }'

Permissions

• User must have GLOBAL_SETTINGS + MANAGE permission in the project

Notes and Warnings

• Name Cannot Change:

  • Group name comes from the path parameter {ipGroupName}

• Description and ipList:

  • description is updated from the body
  • When ipList is omitted or empty, backend clears all IPs in the group
  • To update only metadata without touching IPs, do not use this endpoint after IPs were added — or include the current ipList in the body

• Automatic Deployment:

  • Changes are deployed to Gateway environments after update

Related Documentation

• Create IP Group - Create a new IP Group
• Delete IP Group - Delete an IP Group