Policy

Asset Compliance For Policy Rules Under Policy Group

Changed on Aug 6, 2026

Retrieves an asset resource with rule compliance status against all rules under the specified policy group.

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

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/assets/:assetId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

assetIdinteger required

The identifier of the asset.

Example:282

groupIdinteger required

The identifier of the policy group.

Example:71

policyIdinteger required

The identifier of the policy

Example:84

Response

hostnamestring

The primary host name (local or FQDN) of the asset.

idobject

The identifier of the asset.

ipstring

The primary IPv4 or IPv6 address of the asset.

status'passed' | 'failed' | 'notApplicable'

The overall compliance status of the asset.

Example response

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "os": {
    "architecture": "x86",
    "configurations": [
      {
        "name": "<name>",
        "value": "<value>"
      }
    ],
    "cpe": {
      "edition": "enterprise",
      "part": "o",
      "product": "windows_server_2008",
      "update": "sp1",
      "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise",
      "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*",
      "vendor": "microsoft",
      "version": "-"
    },
    "description": "Microsoft Windows Server 2008 Enterprise Edition SP1",
    "family": "Windows",
    "id": 35,
    "product": "Windows Server 2008 Enterprise Edition",
    "systemName": "Microsoft Windows",
    "type": "Workstation",
    "vendor": "Microsoft",
    "version": "SP1"
  }
}

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