List IP Groups

Endpoint

GET /apiops/projects/{projectName}/ipGroups/

Authentication

Requires a Personal API Access Token.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "resultList": [
    {
      "name": "AllowedIPs",
      "description": "Allowed IP addresses for API access",
      "ipList": [
        "192.168.1.10",
        "10.0.0.0/24"
      ]
    },
    {
      "name": "BlockedIPs",
      "description": null,
      "ipList": []
    }
  ],
  "resultCount": 2
}

IP Groups are sorted by name in ascending order.

Response Fields

Field	Type	Description
name	string	IP Group name (unique within the project)
description	string	IP Group description, null when not set
ipList	array[string]	IP addresses and CIDR ranges in the group; empty array when the group has no entries

Error Response (401 Unauthorized)

{
  "status": "FAILURE",
  "resultMessage": "User not found!"
}

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/ipGroups/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Notes and Warnings

• Read-only: This endpoint does not modify anything and does not trigger a deployment
• Empty project: A project with no IP Groups returns resultList: [] and resultCount: 0, not an error

Permissions

• User must have GLOBAL_SETTINGS + VIEW permission in the project

Related Documentation

• Get IP Group - Get a single IP Group
• Create IP Group - Create a new IP group
• Add IPs to Group - Add IP addresses to group