Asset

Software

Changed on Aug 6, 2026

Returns the details for software.

get/api/3/software/{id}

Request

Base URL
https://<host>:<port>
Auth
none declared
TypeScript
https://skmtc.dev/rapid7/apis/rapid7-vm-api/docs/api/3/software/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

The identifier of the software.

Response

descriptionstring

The description of the software.

familystring

The family of the software.

idobject

The identifier of the software.

productstring

The product of the software.

typestring

The version of the software.

vendorstring

The vendor of the software.

versionstring

The version of the software.

Example response

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

Changes

Aug 6, 20263a8197c22d71 Revision 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

Operation history