Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rapid7 Scan Template API

Scan Template Resource Controller

Rapid7 Scan Template API is one of 50 APIs that Rapid7 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scan Template. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths, and defines 31 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.

5 operations 2 paths 31 schemas 1 DELETE2 GET1 POST1 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 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.

Scan Template 5

Scan Template Resource Controller

GET
/api/3/scan_templates
Scan Templates
getScanTemplates → 200401404500503
POST
/api/3/scan_templates
Scan Templates
createScanTemplate 1 param → 200400401500503
GET
/api/3/scan_templates/{id}
Scan Template
getScanTemplate 1 param → 200401404500503
PUT
/api/3/scan_templates/{id}
Scan Template
updateScanTemplate 2 params → 200400401404500503
DELETE
/api/3/scan_templates/{id}
Scan Template
deleteScanTemplate 1 param → 200401404500503

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are ScanTemplate (18 properties), ScanTemplateWebSpiderPerformance (9 properties), ScanTemplateAssetDiscovery (9 properties), ScanTemplateWebSpider (8 properties). Each schema is shown below with its type and property counts.

ScanTemplateDiscoveryPerformanceParallelism
object
2 properties
NotFoundError
object
3 properties 1 required
InternalServerError
object
3 properties 1 required
ScanTemplateVulnerabilityChecks
object
7 properties
ScanTemplateDatabase
object
4 properties
CreatedReference«ScanTemplateID,Link»
object
2 properties
Links
object
1 property
ScanTemplateVulnerabilityCheckCategories
object
3 properties
ScanTemplateServiceDiscoveryTcp
object
5 properties
UnauthorizedError
object
3 properties 1 required
ScanTemplateAssetDiscovery
object
9 properties
ScanTemplateDiscoveryPerformancePacketsRate
object
3 properties
ServiceUnavailableError
object
3 properties 1 required
ScanTemplateDiscoveryPerformance
object
5 properties
ScanTemplateWebSpiderPerformance
object
9 properties
VulnerabilityCheckType
object
3 properties
ScanTemplate
object
18 properties
ScanTemplateDiscoveryPerformanceScanDelay
object
2 properties
Telnet
object
6 properties
BadRequestError
object
3 properties 1 required
ScanTemplateServiceDiscovery
object
3 properties
Policy
object
4 properties
ScanTemplateDiscovery
object
3 properties
ScanTemplateWebSpiderPaths
object
3 properties
Resources«ScanTemplate»
object
2 properties
ScanTemplateWebSpiderPatterns
object
2 properties
ScanTemplateVulnerabilityCheckIndividual
object
3 properties
ScanTemplateDiscoveryPerformanceTimeout
object
3 properties
ScanTemplateServiceDiscoveryUdp
object
4 properties
Link
object
2 properties
ScanTemplateWebSpider
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapid7-scan-template-api-openapi.yml Raw ↑

Other APIs Rapid7 publishes across the network.

Rapid7 InsightVM Cloud API
Rapid7 Insight Platform API
Rapid7 InsightIDR API
Rapid7 Accounts API
Rapid7 Administration API
Rapid7 Apps API
Rapid7 Asset API
Rapid7 Asset Discovery API
Rapid7 Asset Group API
Rapid7 Assets API
Rapid7 Attachments API
Rapid7 Attack Templates API