Get Policy Group

Endpoint

GET /apiops/projects/{projectName}/policyGroups/{policyGroupName}/

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
policyGroupName	string	Yes	Policy group name (the group must already exist)

Query Parameters

None

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "resultList": [
    {
      "id": "665f2a1c9b3e4a0012ab35aa",
      "name": "standard-security-bundle",
      "targetPipeline": "REQUEST"
    }
  ],
  "resultCount": 1
}

Response Fields

Field	Type	Description
status	string	Response status: SUCCESS or FAILURE
resultList	array	Single-element list containing the policy group descriptor
resultCount	integer	Always 1 on success

Policy Group Descriptor Fields

Field	Type	Description
id	string	Internal policy group ID
name	string	Policy group name
targetPipeline	string	Pipeline the group is bound to: REQUEST, RESPONSE or ERROR

EnumStatus

• SUCCESS - Operation successful
• FAILURE - Operation failed

Error Response (400 Bad Request)

{
  "status": "FAILURE",
  "resultMessage": "Policy group (name: standard-security-bundle) was not found!"
}

Error Response (401 Unauthorized)

{
  "status": "FAILURE",
  "resultMessage": "Token is not valid!"
}

cURL Example

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

Notes and Warnings

• Lightweight Response: Only id, name and targetPipeline are returned. The embedded policy list — including any of its policies' @SecretData fields — is never returned by this endpoint, not even masked.
• Case-Insensitive Match: policyGroupName is matched case-insensitively against the stored name.
• Not Found: Requesting a name that does not exist returns a 400 Bad Request with a FAILURE status, not 404.
• Permission: Requires API_MANAGEMENT + VIEW in the project.

Related Documentation

• List Policy Groups - List all policy groups in a project
• Update Policy Group - Update this policy group
• Delete Policy Group - Delete this policy group
• Policy Groups API - Resource overview