Create IP Group

Creates a new IP Group. IP Groups allow you to group multiple IP addresses or CIDR ranges together for use in policies. The group is created empty (no IPs); use Add IPs endpoint to add IPs.

​

Endpoint

POST /apiops/projects/{projectName}/ipGroups/

​

Authentication

Requires a Personal API Access Token.

​

Header

Authorization: Bearer YOUR_TOKEN

​

Request

​

Headers

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

​

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name

​

Request Body

​

Full JSON Body Example - Basic IP Group

{
  "name": "AllowedIPs",
  "description": "Allowed IP addresses for API access"
}

​

Full JSON Body Example - IP Group without Description

{
  "name": "BlockedIPs"
}

​

Request Body Fields

Field	Type	Required	Default	Description
name	string	Yes	-	IP Group name (unique identifier within project)
description	string	No	-	IP Group description

​

Notes

• name must be unique within the project
• name must not be empty
• IP Group is created empty (no IPs)
• Use Add IPs endpoint to add IP addresses after creation

​

Response

​

Success Response (200 OK)

{
  "success": true
}

​

Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "name value can not be empty!"
}

or

{
  "error": "bad_request",
  "error_description": "An IP Group with same name (AllowedIPs) already exists in project!"
}

​

Common Causes

• Missing or empty name field
• IP Group name already exists in project

​

cURL Example

curl -X POST \
  "https://demo.apinizer.com/apiops/projects/MyProject/ipGroups/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "AllowedIPs",
    "description": "Allowed IP addresses for API access"
  }'

​

Notes and Warnings

• Name Uniqueness:

  • IP Group name must be unique within the project
  • If name already exists, creation will fail

• Empty Group:

  • IP Group is created empty (no IPs)
  • Use Add IPs endpoint to add IP addresses

​

Permissions

• User must have GLOBAL_SETTINGS + MANAGE permission in the project

​

Related Documentation

• Update IP Group - Update an IP Group
• Add IPs to Group - Add IP addresses to group