Overview
The IP Groups API provides endpoints for managing IP Groups in Apinizer. IP Groups allow you to group multiple IP addresses or CIDR ranges together for use in policies (e.g., Black IP, White IP policies).Endpoints
CRUD Operations
- Create IP Group - Create a new IP Group
- Update IP Group - Update an existing IP Group
- Delete IP Group - Delete an IP Group
IP Management
- Add IPs to Group - Add IP addresses to an IP Group
- Update IPs in Group - Replace all IPs in an IP Group
- Delete IPs from Group - Remove IP addresses from an IP Group
Authentication
All endpoints require authentication using a Personal API Access Token.Permissions
GET Operations (List IP Groups)
- User must have any permission in the project (read access)
POST/PUT/DELETE Operations (Create/Update/Delete IP Group, Manage IPs)
- User must have
GLOBAL_SETTINGS+MANAGEpermission in the project
Permission Requirements
| Operation | Required Permission |
|---|---|
| List IP Groups | Any permission in project |
| Create/Update/Delete IP Group | GLOBAL_SETTINGS + MANAGE |
| Add/Update/Delete IPs in Group | GLOBAL_SETTINGS + MANAGE |
Related Documentation
- Authentication Guide - How to obtain and use API tokens
- Error Handling - Error response formats
- Black IP Policy - Use IP Groups in Black IP policy
- White IP Policy - Use IP Groups in White IP policy