IP Groups API
Endpoints
CRUD Operations
- List IP Groups - List all IP Groups of a project
- Get IP Group - Get a single IP Group
- 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
Read operations require GLOBAL_SETTINGS + VIEW, all write operations require GLOBAL_SETTINGS + MANAGE permission in the project.
| Operation | Required Permission |
|---|---|
| List / Get IP Group | GLOBAL_SETTINGS + VIEW |
| 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