RArapid7
Asset

Asset

Changed on

Returns the specified asset.

get/api/3/assets/{id}

Request

Path parameters

idinteger required

The identifier of the asset.

Example:282

Response

OK

assessedForPoliciesboolean

Whether the asset has been assessed for policies at least once.

assessedForVulnerabilitiesboolean

Whether the asset has been assessed for vulnerabilities at least once.

hostNamestring

The primary host name (local or FQDN) of the asset.

idobject

The identifier of the asset.

ipstring

The primary IPv4 or IPv6 address of the asset.

macstring

The primary Media Access Control (MAC) address of the asset. The format is six groups of two hexadecimal digits separated by colons.

osstring

The full description of the operating system of the asset.

osCertaintystring

The certainty of the operating system fingerprint.

rawRiskScorenumber double

The base risk score of the asset.

riskScorenumber double

The risk score (with criticality adjustments) of the asset.

type'unknown' | 'guest' | 'hypervisor' | 'physical' | 'mobile'

The type of asset.

Example response

{
  "addresses": [
    {
      "ip": "123.245.34.235",
      "mac": "12:34:56:78:90:AB"
    }
  ],
  "assessedForVulnerabilities": true,
  "configurations": [
    {
      "name": "<name>",
      "value": "<value>"
    }
  ],
  "databases": [
    {
      "description": "Microsoft SQL Server",
      "id": 13,
      "name": "MSSQL"
    }
  ],
  "files": [
    {
      "attributes": [
        {
          "name": "<name>",
          "value": "<value>"
        }
      ],
      "name": "ADMIN$",
      "size": -1,
      "type": "directory"
    }
  ],
  "history": [
    {
      "date": "2018-04-09T06:23:49Z",
      "type": "SCAN",
      "version": 8
    }
  ],
  "hostName": "corporate-workstation-1102DC.acme.com",
  "hostNames": [
    {
      "name": "corporate-workstation-1102DC.acme.com",
      "source": "DNS"
    }
  ],
  "ids": [
    {
      "id": "c56b2c59-4e9b-4b89-85e2-13f8146eb071",
      "source": "WQL"
    }
  ],
  "ip": "182.34.74.202",
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "mac": "AB:12:CD:34:EF:56",
  "os": "Microsoft Windows Server 2008 Enterprise Edition SP1",
  "osCertainty": "0.75",
  "osFingerprint": {
    "architecture": "x86",
    "configurations": [
      {
        "name": "<name>",
        "value": "<value>"
      }
    ],
    "cpe": {
      "edition": "enterprise",
      "part": "o",
      "product": "windows_server_2008",
      "update": "sp1",
      "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise",
      "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*",
      "vendor": "microsoft",
      "version": "-"
    },
    "description": "Microsoft Windows Server 2008 Enterprise Edition SP1",
    "family": "Windows",
    "id": 35,
    "product": "Windows Server 2008 Enterprise Edition",
    "systemName": "Microsoft Windows",
    "type": "Workstation",
    "vendor": "Microsoft",
    "version": "SP1"
  },
  "rawRiskScore": 31214.3,
  "riskScore": 37457.16,
  "services": [
    {
      "configurations": [
        {
          "name": "<name>",
          "value": "<value>"
        }
      ],
      "databases": [
        {
          "description": "Microsoft SQL Server",
          "id": 13,
          "name": "MSSQL"
        }
      ],
      "links": [
        {
          "href": "https://hostname:3780/api/3/...",
          "rel": "self"
        }
      ],
      "name": "CIFS Name Service",
      "nic": "eth0",
      "port": 139,
      "product": "Samba",
      "protocol": "tcp",
      "userGroups": [
        {
          "id": 972,
          "name": "Administrators"
        }
      ],
      "users": [
        {
          "fullName": "Smith, John",
          "id": 8952,
          "name": "john_smith"
        }
      ],
      "version": "3.5.11",
      "webApplications": [
        {
          "id": 30712,
          "pages": [
            {
              "linkType": "html-ref",
              "path": "/docs/config/index.html",
              "response": 200
            }
          ],
          "root": "/",
          "virtualHost": "102.89.22.253"
        }
      ]
    }
  ],
  "software": [
    {
      "configurations": [
        {
          "name": "<name>",
          "value": "<value>"
        }
      ],
      "cpe": {
        "edition": "enterprise",
        "part": "o",
        "product": "windows_server_2008",
        "update": "sp1",
        "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise",
        "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*",
        "vendor": "microsoft",
        "version": "-"
      },
      "description": "Microsoft Outlook 2013 15.0.4867.1000",
      "family": "Office 2013",
      "product": "Outlook 2013",
      "type": "Productivity",
      "vendor": "Microsoft",
      "version": "15.0.4867.1000"
    }
  ],
  "userGroups": [
    {
      "id": 972,
      "name": "Administrators"
    }
  ],
  "users": [
    {
      "fullName": "Smith, John",
      "id": 8952,
      "name": "john_smith"
    }
  ],
  "vulnerabilities": {
    "critical": 16,
    "exploits": 4,
    "moderate": 3,
    "severe": 76,
    "total": 95
  }
}

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