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 |
| ipGroupName | string | Yes | IP Group name (cannot be changed) |
Request Body
Full JSON Body Example
Request Body Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string | Yes | - | IP Group name (must match path parameter, cannot be changed) |
| description | string | No | - | IP Group description (can be updated) |
Notes
namemust match the IP Group name in path (cannot be changed)- Only
descriptioncan be updated - IP addresses are not updated by this endpoint (use IP management endpoints)
Response
Success Response (200 OK)
Error Response (400 Bad Request)
cURL Example
Permissions
- User must have
GLOBAL_SETTINGS+MANAGEpermission in the project
Notes and Warnings
-
Name Cannot Change:
- Name is used as identifier and cannot be changed
- Use the existing name in the request
-
Description Only:
- Only description can be updated
- IP addresses are not affected by this endpoint
Related Documentation
- Create IP Group - Create a new IP Group
- Delete IP Group - Delete an IP Group

