An Attack Template describes if and how Attacks should be executed during the execution of a Scan. There exist pre-defined, system-provided and immutable templates, as well as custom templates. An Attack Template is a top-level resource within the product, and as such is not affected by the deletion of any Apps.
Rapid7 Attack Templates API is one of 50 APIs that Rapid7 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Attack Templates. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
10 operations
across 5 paths,
and defines 10 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.
10 operations5 paths10 schemas2 DELETE4 GET2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://us.api.insight.rapid7.com/vm/v4
Resource Areas
1
Paths & Operations 10
Across 5 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Attack Templates 10
An Attack Template describes if and how Attacks should be executed during the execution of a Scan. There exist pre-defined, system-provided and immutable templates, as well as cus…
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are EntityModelAttackTemplate (9 properties), AttackTemplate (8 properties), ModuleConfig (7 properties), AttackModule (6 properties). Each schema is shown below with its type and property counts.
AttackModule
object
6 properties3 required
ValidationErrors
object
4 properties
AttackTemplate
object
8 properties1 required
Link
object
4 properties
PageAttackTemplate
object
3 properties
PageMetadata
object
6 properties
ValidationError
object
3 properties
ModuleConfig
object
7 properties
EntityModelAttackTemplate
object
9 properties1 required
Error
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
