Get IP Group

Endpoint

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

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
ipGroupName	string	Yes	IP Group name

Response

Success Response (200 OK)

The requested group is returned as the single element of resultList.

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

Response Fields

Field	Type	Description
name	string	IP Group name
description	string	IP Group description, null when not set
ipList	array[string]	IP addresses and CIDR ranges in the group

Error Response (400 Bad Request)

{
  "status": "FAILURE",
  "resultMessage": "IP Group (AllowedIPs) is not found!"
}

or

{
  "status": "FAILURE",
  "resultMessage": "ipGroupName value can not be empty!"
}

cURL Example

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

Notes and Warnings

• Read-only: This endpoint does not modify anything and does not trigger a deployment
• Name lookup: Like every APIops endpoint, the group is addressed by name, not by ID

Permissions

• User must have GLOBAL_SETTINGS + VIEW permission in the project

Related Documentation

• List IP Groups - List all IP Groups of a project
• Update IP Group - Update an IP Group
• Update IPs in Group - Replace the IP list of a group