Rapid7 VM API
35
AI ReadinessNon-Ready (F)35/100
Official vendor OpenAPI document · agent-readyCRMCustomer Supportbasic330 EndpointsREST
For Agents
Programmatically resources, console commands. Covers 330 operations with basic authentication.
Use for: I need to resources, I want to console commands, Search for information, Find all license
Not supported: Does not handle payments, communications, or developer tools - use for crm only.
Overview This guide documents the Rapid7 VM Application Programming Interface (API) Version 3. This API supports the Representation State Transfer (REST) design pattern. Unless noted otherwise this API accepts and produces the `application/json` media type. This API uses Hypermedia as the Engine of Application State (HATEOAS) and is hypermedia friendly. All API connections must be made to the secu. The API exposes 330 endpoints secured with basic authentication.
Install Jentic One Beta
Connect the Rapid7 VM API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Rapid7 VM API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Frapid7.com%2Frapid7" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Frapid7.com%2Frapid7" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Rapid7 VM API.
Resources
Console Commands
Information
License
Logs
Properties
Use Cases
Patterns agents use Rapid7 VM API for, with concrete tasks.
★ CRM Operations
Use the Rapid7 VM API to perform crm operations programmatically. The API provides 330 endpoints covering core functionality including resources, console commands, information.
Call GET /api/3 to resources
Automated Root Management
Automate root operations by combining multiple Rapid7 VM API endpoints. Agents can console commands and then information in a single workflow.
Call POST /api/3/administration/commands to console commands, then verify the result
AI Agent Integration via Jentic
AI agents discover and call Rapid7 VM API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.
Search Jentic for 'resources', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
330 endpoints — overview this guide documents the rapid7 vm application programming interface (api) version 3.
METHOD
PATH
DESCRIPTION
GET
/api/3
Resources
POST
/api/3/administration/commands
Console Commands
GET
/api/3/administration/info
Information
POST
/api/3/administration/license
License
GET
/api/3/administration/license
License
GET
/api/3/administration/logs
Logs
GET
/api/3/administration/properties
Properties
GET
/api/3/administration/settings
Settings
GET
/api/3
Resources
POST
/api/3/administration/commands
Console Commands
GET
/api/3/administration/info
Information
POST
/api/3/administration/license
License
GET
/api/3/administration/license
License
GET
/api/3/administration/logs
Logs
GET
/api/3/administration/properties
Properties
GET
/api/3/administration/settings
Settings
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
R
Rapid7 VM API
- Non-Ready (F)35/100
46
Foundational Compliance68
Developer Experience & Jentic Compatibility61
AI-Readiness & Agent Experience43
Agent Usability10
Security62
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
46
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: DSignals: 4
83%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
0%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
68
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B+Signals: 4
19%
Example Density
How richly the API is illustrated with examples.
87%
Example Validity
Percentage of examples that conform to their schemas.
75%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
93%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
61
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: B-Signals: 4
82%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
99%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
61%
Summary Coverage
Coverage of summaries across operations/tags/info.
43
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: D-Signals: 1
43%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
10
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
10%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
62
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B-Signals: 1
62%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Rapid7 VM API by hand means handling its basic auth, pointing every call at your own host and port, and hand-coding requests across hundreds of administration, asset, and scan endpoints. Through Jentic you install once, import the Rapid7 VM API from the API Directory, store the credential once, and your agent calls it.
Permission scoping
Rapid7 puts resource ids in the URL path across its asset and scan endpoints, so a rule can pin your agent to one resource such as a single asset or scan. You choose the operations it may call, so destructive ones like posting administration commands or updating the license are not included unless you add them.
Credential isolation
Your Rapid7 credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'list scanned assets' or 'get scan results', and Jentic returns the matching Rapid7 operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Rapid7 VM API through Jentic.
What authentication does the Rapid7 VM API use?
The Rapid7 VM API uses HTTP Basic authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.
Can I resources with the Rapid7 VM API?
Yes. Use the GET /api/3 endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the Rapid7 VM API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I resources through Jentic?
Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'resources'. Jentic returns the matching Rapid7 VM API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.
How many endpoints does the Rapid7 VM API have?
The Rapid7 VM API exposes 330 endpoints covering root, asset, asset discovery operations.
Can I limit what my agent is allowed to do with the Rapid7 VM API?
Yes. Because you run Jentic One yourself, your own rules decide which Rapid7 operations and credentials the agent may use. Rapid7 puts resource ids in the URL path across its asset and scan endpoints, so you can pin the agent to a single asset or scan rather than the whole console. You also choose which operations it may call, so destructive ones like posting administration commands or updating the license stay off limits unless you explicitly add them.
GET STARTED