Asset

Operating System

Changed on Aug 6, 2026

Returns the details for an operating system.

get/api/3/operating_systems/{id}

Request

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

Path parameters

idinteger required

The identifier of the operating system.

Response

architecturestring

The architecture of the operating system.

descriptionstring

The description of the operating system (containing vendor, family, product, version and architecture in a single string).

familystring

The family of the operating system.

idinteger

The identifier of the operating system.

productstring

The name of the operating system.

systemNamestring

A combination of vendor and family (with redundancies removed), suitable for grouping.

typestring

The type of operating system.

vendorstring

The vendor of the operating system.

versionstring

The version of the operating system.

Example response

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

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