Scan Engine

Scan Engines

Changed on Aug 6, 2026

Creates a new scan engine.

post/api/3/scan_engines

Request

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

Request body

addressstring required

The address the scan engine is hosted.

contentVersionstring

The content version of the scan engine.

idobject

The identifier of the scan engine.

isAWSPreAuthEngineboolean

A boolean of whether the Engine is of type AWS Pre Authorized

lastRefreshedDatestring date-time

The date the engine was last refreshed. Date format is in ISO 8601.

lastUpdatedDatestring date-time

The date the engine was last updated. Date format is in ISO 8601.

namestring required

The name of the scan engine.

portinteger required

The port used by the scan engine to communicate with the Security Console.

productVersionstring

The product version of the scan engine.

serialNumberstring

The serial number of the scan engine.

sitesobject[]

A list of identifiers of each site the scan engine is assigned to.

status'active' | 'incompatible-version' | 'not-responding' | 'pending-authorization' | 'unknown'

The scan engine status. Can be one of the following values:

Value	Description
"active"	The scan engine is active.
"incompatible-version"	The product version of the remote scan engine is not compatible with the Security Console.
"not-responding"	The scan engine is not responding to the Security Console.
"pending-authorization"	The Security Console is not yet authorized to connect to the scan engine.
"unknown"	The status of the scan engine is unknown.

Example request

{
  "address": "corporate-scan-engine-001.acme.com",
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "name": "Corporate Scan Engine 001",
  "port": 40894
}

Response

Created

idobject

The identifier of the scan engine.

Example response

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ]
}

Changes

Aug 6, 20263a8197c22d71 Revision changes
- breaking
  added required request body
- 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