Rapid7 VM API
✓ Official Vendor SpecCRMCustomer 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://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | 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
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
Rapid7 VM API basic credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw secrets never enter the agent context.
Intent-based discovery
Agents search by intent (e.g., 'resources') and Jentic returns the matching Rapid7 VM API operation with its input schema, so the agent can call the right endpoint without browsing docs.
Time to first call
Direct Rapid7 VM API integration: 1-3 days for auth handling, response parsing, and error cases. Through Jentic: under 1 hour — search, load schema, execute.
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 the MAXsystem vault 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 at https://app.jentic.com/sign-up, 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.
GET STARTED