RArapid7
Policy

Policy

Changed on

Retrieves the specified policy.

get/api/3/policies/{policyId}

Request

Path parameters

policyIdinteger required

The identifier of the policy

Example:84

Response

OK

enabledobject[]

The identifiers of the policies enabled to be checked during a scan. No policies are enabled by default.

recursiveWindowsFSSearchboolean

Whether recursive windows file searches are enabled, if your internal security practices require this capability. Recursive file searches can increase scan times by several hours, depending on the number of files and other factors, so this setting is disabled for Windows systems by default. Defaults to false.

storeSCAPboolean

Whether Asset Reporting Format (ARF) results are stored. If you are required to submit reports of your policy scan results to the U.S. government in ARF for SCAP certification, you will need to store SCAP data so that it can be exported in this format. Note that stored SCAP data can accumulate rapidly, which can have a significant impact on file storage. Defaults to false.

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