Rapid7 Targets API
A Target essentially specifies an allowlisted Fully Qualified Domain Name (FQDN) which can be Scanned by InsightAppSec. A Target can be created, edited and deleted by an API consumer provided the permissions inherited by the authentication method allow it, though if a Target has been successfully Scanned at least once it can no longer be deleted. If it is no longer desirable to allow Scans to be executed against a given Target, it can be disabled. A Target is a top-level resource within the product, and as such is not affected by the deletion of any Apps.
Rapid7 Targets API is one of 50 APIs that Rapid7 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Targets. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 5 operations across 2 paths, and defines 8 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 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
A Target essentially specifies an allowlisted Fully Qualified Domain Name (FQDN) which can be Scanned by InsightAppSec. A Target can be created, edited and deleted by an API consu…
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are PageMetadata (6 properties), EntityModelTarget (5 properties), Link (4 properties), ValidationErrors (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.