RArapid7
Policy

Policy Compliance Summaries

Changed on

Retrieves a compliance summary of all policies.

get/api/3/policy/summary

Request

Response

OK

decreasedComplianceinteger

The total number of policies whose overall compliance has decreased between the last two scans of all assets. The list of scanned policies is based on the user's list of accessible assets.

increasedComplianceinteger

The total number of policies whose overall compliance has increased between the last two scans of all assets. The list of scanned policies is based on the user's list of accessible assets.

numberOfPoliciesinteger

The total number of policies available in the Security Console.

overallCompliancenumber float

The ratio of compliant rules to the total number of rules across all policies.

scannedPoliciesinteger

The total number of policies that were evaluated against assets and have applicable results. The assets considered in the calculation are based on the user's list of accessible assets.

Example response

{
  "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