Rapid7 Engine Groups API
An Engine Group is a resource which defines a container for a logical grouping of Engines and therefore the purpose of assigning Scans to one of those Engines. Any created Engine Group can contain 0 or more Engines that are strictly hosted within an On-Premise environment. Any Engine which isn't assigned to an explicitly-defined Engine Group inherently belongs to the 'Default' Engine Group (the Default Engine Group cannot be explicitly created, modified, deleted or referenced, it is purely conceptual). Any Scans submitted which use a Scan Config with an explicit assignment to an Engine Group will follow the following rules:If the Engine Group contains only OFFLINE Engines, the scan will immediately failIf the Engine Group contains at least 1 Engine which isn't OFFLINE, the scan will wait to be acquired
Rapid7 Engine Groups API is one of 50 APIs that Rapid7 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Engine Groups. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 6 operations across 3 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version v1.
Requests are made against a single base URL, https://[region].api.insight.rapid7.com/ias/v1.
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
An Engine Group is a resource which defines a container for a logical grouping of Engines and therefore the purpose of assigning Scans to one of those Engines. Any created Engine…
Schemas 11
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are EntityModelEngine (9 properties), engine_group (7 properties), PageMetadata (6 properties), Link (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Rapid7 12
Other APIs Rapid7 publishes across the network.