Endpoint
Authentication
Requires a Personal API Access Token.Header
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
Full JSON Body Example - IP Group without Description
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
namemust be unique within the projectnamemust 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)
Error Response (400 Bad Request)
Common Causes
- Missing or empty
namefield - IP Group name already exists in project
cURL Example
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+MANAGEpermission in the project
Related Documentation
- Update IP Group - Update an IP Group
- Add IPs to Group - Add IP addresses to group

