Policy

Policy Group

Changed on Aug 6, 2026

Retrieves the specified policy group.

get/api/3/policies/{policyId}/groups/{groupId}

Request

Base URL
https://<host>:<port>
Auth
none declared
TypeScript
https://skmtc.dev/rapid7/apis/rapid7-vm-api/docs/api/3/policies/:policyId/groups/:groupId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

groupIdinteger required

The identifier of the policy group.

Example:71

policyIdinteger required

The identifier of the policy

Example:84

Response

descriptionstring

A description of the policy group.

idstring

The textual representation of the policy group identifier.

namestring

The name of the policy group.

scopestring

The textual representation of the policy group scope. Policy groups that are automatically available have "Built-in" scope, whereas policy groups created by users have scope as "Custom".

status'PASS' | 'FAIL' | 'NOT_APPLICABLE'

The overall compliance status of the policy group.

surrogateIdobject

The identifier of the policy group.

titlestring

The title of the policy group as visible to the user.

Example response

{
  "assets": {
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ]
  },
  "benchmark": {
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ]
  },
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "policy": {
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ]
  }
}

Changes

Aug 6, 20263a8197c22d71 Revision changes
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status

Operation history