RArapid7
Policy

Policy Rule

Changed on

Retrieves the specified policy rule.

get/api/3/policies/{policyId}/rules/{ruleId}

Request

Path parameters

policyIdinteger required

The identifier of the policy

Example:84
ruleIdinteger required

The identifier of the policy rule.

Example:53

Response

OK

descriptionstring

A description of the rule.

idstring

The textual representation of the policy rule identifier.

isCustomboolean

A flag indicating whether the policy rule is custom.

namestring

The name of the rule.

role'full' | 'unscored' | 'unchecked'

The role of the policy rule. It's value determines how it's results affect compliance.

scopestring

The textual representation of the policy rule scope. Policy rules that are automatically available have "Built-in" scope, whereas policy rules created by users have scope as "Custom".

status'PASS' | 'FAIL' | 'NOT_APPLICABLE'

The overall compliance status of the policy rule.

surrogateIdobject

The identifier of the policy rule.

titlestring

The title of the policy rule as visible to the user.

Example response

{
  "assets": {
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ]
  },
  "benchmark": {
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ]
  },
  "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