RArapid7
Vulnerability Check

Check

Changed on

Returns the vulnerability check.

get/api/3/vulnerability_checks/{id}

Request

Path parameters

idstring required

The identifier of the vulnerability check.

Example:WINDOWS-HOTFIX-MS14-009-01123281-bac0-44d8-a729-cd31c19d6bd1

Response

OK

idobject

The identifier of the vulnerability check.

pluginstring

The name of the plugin (module) the check belongs to.

potentialboolean

Whether the check results in potential vulnerabilities.

requiresCredentialsboolean

Whether the check requires credentials in order to run.

safeboolean

Whether the checked is deemed to be "safe" to run. A safe check is one that can be run without negatively impacting the host it is run against.

serviceboolean

Whether the check operates against a service, or false it it is a local check.

uniqueboolean

Whether the check may only register a result once during a scan of host. Otherwise, the tests in the check can run multiple times, possibly registering multiple results.

vulnerabilityobject

The identifier of the vulnerability.

Example response

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "plugin": "WindowsHotfixScanner",
  "requiresCredentials": true,
  "safe": true
}

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