This Context7 documentation provides comprehensive coverage of the Rapid7 InsightVM API v3, automatically generated from the official OpenAPI 2.0 specification.
The InsightVM Application Programming Interface (API) v3 enables programmatic access to vulnerability management capabilities including:
- Asset Management: Discover, track, and manage IT assets
- Vulnerability Assessment: Scan and identify security vulnerabilities
- Risk Management: Prioritize and track remediation efforts
- Reporting: Generate comprehensive security reports
- Site Management: Organize and configure scan targets
- Policy Compliance: Assess compliance with security policies
- REST Design: Follows RESTful design patterns
- JSON Format: Uses
application/jsonmedia type - HATEOAS: Implements Hypermedia as the Engine of Application State
- HTTPS Required: All connections must use HTTPS
- Authentication: HTTP Basic Authentication with optional 2FA
This Context7 documentation is organized into 20 functional modules, each covering specific API capabilities:
- Administration - System administration operations (6 endpoints)
- Root - API discovery and entry points (1 endpoint)
- Assets - Asset lifecycle management (25 endpoints)
- Asset Groups - Asset organization and grouping (22 endpoints)
- Asset Discovery - Automated asset discovery mechanisms (10 endpoints)
- Sites - Scan target configuration and management (84 endpoints)
- Scans - Scan execution and management (5 endpoints)
- Scan Engines - Scan engine configuration (22 endpoints)
- Scan Templates - Scan configuration templates (5 endpoints)
- Vulnerabilities - Vulnerability content and management (24 endpoints)
- Vulnerability Checks - Vulnerability check definitions (4 endpoints)
- Vulnerability Results - Assessment results and findings (7 endpoints)
- Vulnerability Exceptions - Exception management (7 endpoints)
- Remediation - Remediation guidance and tracking (1 endpoint)
- Policies - Policy management and assessment (26 endpoints)
- Policy Overrides - Policy exception handling (8 endpoints)
- Reports - Report generation and distribution (13 endpoints)
- Users - User management and permissions (32 endpoints)
- Credentials - Shared credential management (6 endpoints)
- Tags - Asset tagging and categorization (21 endpoints)
Each endpoint documentation includes:
- HTTP Method & Path: Complete endpoint specification
- Parameters: Detailed parameter documentation with types and examples
- Request Body: JSON schema and examples for POST/PUT operations
- Authentication: Security requirements and permissions
- Status Codes: All possible HTTP response codes
- Response Schemas: Complete data structure definitions
- JSON Examples: Auto-generated realistic response examples
- Error Handling: Detailed error response formats
- Content Types: Supported request/response formats
- Operation IDs: Unique identifiers for code generation
- Schema References: Links to reusable data models
- API Version: v3
- Base URL:
https://<host>:<port>/api/3/ - OpenAPI Version: 2.0 (Swagger)
- Total Endpoints: 328
- Schema Definitions: 315
- Authentication: HTTP Basic + Optional 2FA Token
- Authentication Setup: Configure HTTP Basic Authentication credentials
- Base URL Configuration: Set your InsightVM console URL
- API Discovery: Start with the Root endpoint to discover available resources
- Choose Module: Select the appropriate documentation module for your use case
This documentation is optimized for Context7 with:
- Structured Navigation: Organized by functional domains
- Rich Examples: Auto-generated JSON examples from OpenAPI schemas
- Complete Coverage: All 328 endpoints documented
- Search-Friendly: Detailed descriptions and parameter information
- Developer-Ready: Code generation compatible operation IDs
Generated from InsightVM API v3 OpenAPI 2.0 specification with 315 schema definitions