Scan Engine

Engine Pool

Retrieves the details for an engine pool.

get/api/3/scan_engine_pools/{id}

Request

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

idinteger required

The identifier of the scan engine.

Example:2

The identifier of the engine pool.

enginesobject[]

The identifiers of the scan engines in the engine pool.

idobject required

The identifier of the scan engine.

namestring required

The name of the scan engine.

sitesobject[]

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

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "name": "Corporate Scan Engine 001"
}