GET /api/3/sites/{id} – Rapid7 VM API

Site

Changed on Aug 6, 2026

Retrieves the site with the specified identifier.

get/api/3/sites/{id}

Request

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

Path parameters

idinteger required

The identifier of the site.

Response

assetsinteger

The number of assets that belong to the site.

The type of discovery connection configured for the site. This property only applies to dynamic sites.

descriptionstring

The site description.

idobject

The identifier of the site.

importancestring

The site importance.

lastScanTimestring date-time

The date and time of the site's last scan.

namestring

The site name.

riskScorenumber double

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

scanEngineinteger

The identifier of the scan engine configured in the site.

scanTemplatestring

The identifier of the scan template configured in the site.

type'agent' | 'dynamic' | 'static'

The type of the site.

Example response

{
  "assets": 768,
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "riskScore": 4457823.78,
  "vulnerabilities": {
    "critical": 16,
    "moderate": 3,
    "severe": 76,
    "total": 95
  }
}

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