RArapid7
Policy

Policies For Asset

Changed on

Retrieves the list of policies with compliance results for the specified asset.

get/api/3/assets/{assetId}/policies

Request

Path parameters

assetIdinteger required

The identifier of the asset.

Example:282

Query parameters

applicableOnlyboolean

An optional boolean parameter indicating the policies retrieved should only include those with a policy compliance status of either a PASS of FAIL result. Default value is false, which will also include policies with a compliance status of NOT_APPLICABLE.

pageinteger

The index of the page (zero-based) to retrieve.

sizeinteger

The number of records per page to retrieve.

sortstring[]

The criteria to sort the records by, in the format: property[,ASC|DESC]. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.

Response

OK

Example response

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "page": {
    "number": 6,
    "size": 10,
    "totalPages": 13,
    "totalResources": 123
  },
  "resources": [
    {
      "links": [
        {
          "href": "https://hostname:3780/api/3/...",
          "rel": "self"
        }
      ]
    }
  ]
}

Changes

  • 3a8197c22d71Revision 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