Asset

Operating Systems

Changed on Aug 6, 2026

Returns all operating systems discovered across all assets.

get/api/3/operating_systems

Request

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

Query parameters

pageinteger

The index of the page (zero-based) to retrieve.

sizeinteger

The number of records per page to retrieve.

sortstring[]

The criteria to sort the records by, in the format: property[,ASC|DESC]. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.

Response

Example response

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "page": {
    "number": 6,
    "size": 10,
    "totalPages": 13,
    "totalResources": 123
  },
  "resources": [
    {
      "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