---
title: "Policy Asset Result"
method: GET
path: "/api/3/policies/{policyId}/assets/{assetId}"
tags: ["Policy"]
---

# Policy Asset Result

`GET /api/3/policies/{policyId}/assets/{assetId}`

## Request

- Base URL: `https://<host>:<port>`
- URL: `https://<host>:<port>/api/3/policies/{policyId}/assets/{assetId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/rapid7/apis/rapid7-vm-api/docs/api/3/policies/:policyId/assets/:assetId/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves an asset resource with rule compliance results for the specified asset and policy.

## Path parameters

- `assetId` integer, required: The identifier of the asset.
- `policyId` integer, required: The identifier of the policy

## Response `200`

OK

- PolicyAsset
  - `hostname` string: The primary host name (local or FQDN) of the asset.
  - `id` object: The identifier of the asset.
  - `ip` string: The primary IPv4 or IPv6 address of the asset.
  - `links` Link[], required: Hypermedia links to corresponding or related resources.
    - `deprecation` string
    - `href` string: A hypertext reference, which is either a URI (see <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc3986">RFC 3986</a>) or URI template (see <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc6570">RFC 6570</a>).
    - `hreflang` string
    - `media` string
    - `rel` string: The link relation type. This value is one from the <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc5988#section-6.2">Link Relation Type Registry</a> or is the type of resource being linked to.
    - `title` string
    - `type` string
  - `os` OperatingSystem: The details of the operating system of the asset. At least one of `vendor`, `family`, or `product` must be supplied. This is the preferred means of defining the operating system.
    - `architecture` string: The architecture of the operating system.
    - `configurations` Configuration[]: Configuration key-values pairs enumerated on the operating system.
      - `name` string, required: The name of the configuration value.
      - `value` string: The configuration value.
    - `cpe` OperatingSystemCpe: The Common Platform Enumeration (CPE) of the operating system.
      - `edition` string: Edition-related terms applied by the vendor to the product.
      - `language` string: Defines the language supported in the user interface of the product being described. The format is of the language tag adheres to <a target="_blank" rel="noopener noreferrer" href="https://tools.ietf.org/html/rfc5646">RFC5646</a>.
      - `other` string: Captures any other general descriptive or identifying information which is vendor- or product-specific and which does not logically fit in any other attribute value.
      - `part` 'o' | 'a' | 'h', required: A single letter code that designates the particular platform part that is being identified.
      - `product` string: the most common and recognizable title or name of the product.
      - `swEdition` string: Characterizes how the product is tailored to a particular market or class of end users.
      - `targetHW` string: Characterize the instruction set architecture on which the product operates.
      - `targetSW` string: Characterize the software computing environment within which the product operates.
      - `update` string: Vendor-specific alphanumeric strings characterizing the particular update, service pack, or point release of the product.
      - `v2.2` string: The full CPE string in the <a target="_blank" rel="noopener noreferrer" href="https://cpe.mitre.org/files/cpe-specification_2.2.pdf">CPE 2.2</a> format.
      - `v2.3` string: The full CPE string in the <a target="_blank" rel="noopener noreferrer" href="http://nvlpubs.nist.gov/nistpubs/Legacy/IR/nistir7695.pdf">CPE 2.3</a> format.
      - `vendor` string: The person or organization that manufactured or created the product.
      - `version` string: Vendor-specific alphanumeric strings characterizing the particular release version of the product.
    - `description` string: The description of the operating system (containing vendor, family, product, version and architecture in a single string).
    - `family` string: The family of the operating system.
    - `id` integer: The identifier of the operating system.
    - `product` string: The name of the operating system.
    - `systemName` string: A combination of vendor and family (with redundancies removed), suitable for grouping.
    - `type` string: The type of operating system.
    - `vendor` string: The vendor of the operating system.
    - `version` string: The version of the operating system.
  - `status` 'passed' | 'failed' | 'notApplicable': The overall compliance status of the asset.

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `500`: Internal Server Error
- `503`: Service Unavailable

## Changes

- **2026-08-06** `3a8197c22d71`: 5 info
  - added the media type `application/json;charset=UTF-8` for the response with the status `200`
  - added the media type `application/json;charset=UTF-8` for the response with the status `401`
  - added the media type `application/json;charset=UTF-8` for the response with the status `404`
  - added the media type `application/json;charset=UTF-8` for the response with the status `500`
  - …1 more

[Operation history](https://skmtc.dev/rapid7/apis/rapid7-vm-api/changes/api/3/policies/:policyId/assets/:assetId/get.md)

---

[API](https://skmtc.dev/rapid7/apis/rapid7-vm-api.md) - [All operations](https://skmtc.dev/rapid7/apis/rapid7-vm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rapid7/apis/rapid7-vm-api/revisions/3a8197c22d71?raw)