How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Rapid7

Rapid7 Site API

Resources and operations for managing sites.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 84 operations across 35 paths, and defines 106 schemas. It is described by OpenAPI 3.2.0, at version 3.

Requests are made against a single base URL, https://localhost:3780/.

84 operations 35 paths 106 schemas 22 DELETE28 GET9 POST25 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3
Base URL
https://us.api.insight.rapid7.com/vm/v4
Authentication
HTTP Basic
Contact
Rapid7
Resource Areas
1

Authentication & Security 1

Rapid7 Site API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (Basic).

Paths & Operations 84

Across 35 paths, the API surfaces 84 operations — 22 DELETE, 28 GET, 9 POST, 25 PUT. Each is listed below with its method, path, parameters, and response codes.

Site 84

Resources and operations for managing sites.

GET
/api/3/sites/{id}/assets
Site Assets
getSiteAssets 4 params → 200401404500503
DELETE
/api/3/sites/{id}/assets
Site Assets
removeSiteAssets 1 param → 200401404500503
GET
/api/3/sites
Sites
getSites 3 params → 200401404500503
POST
/api/3/sites
Sites
createSite body → 201400401500503
GET
/api/3/sites/{id}
Site
getSite 1 param → 200401404500503
PUT
/api/3/sites/{id}
Site
updateSite 1 param body → 200400401404500503
DELETE
/api/3/sites/{id}
Site
deleteSite 1 param → 200401404500503
GET
/api/3/sites/{id}/alerts
Site Alerts
getSiteAlerts 1 param → 200401404500503
DELETE
/api/3/sites/{id}/alerts
Site Alerts
deleteAllSiteAlerts 1 param → 200401404500503
GET
/api/3/sites/{id}/alerts/smtp
Site SMTP Alerts
getSiteSmtpAlerts 1 param → 200401404500503
POST
/api/3/sites/{id}/alerts/smtp
Site SMTP Alerts
createSiteSmtpAlert 1 param body → 201400401500503
PUT
/api/3/sites/{id}/alerts/smtp
Site SMTP Alerts
setSiteSmtpAlerts 1 param body → 200400401404500503
DELETE
/api/3/sites/{id}/alerts/smtp
Site SMTP Alerts
deleteAllSiteSmtpAlerts 1 param → 200401404500503
GET
/api/3/sites/{id}/alerts/smtp/{alertId}
Site SMTP Alert
getSiteSmtpAlert 2 params → 200401404500503
PUT
/api/3/sites/{id}/alerts/smtp/{alertId}
Site SMTP Alert
updateSiteSmtpAlert 2 params body → 200400401404500503
DELETE
/api/3/sites/{id}/alerts/smtp/{alertId}
Site SMTP Alert
deleteSiteSmtpAlert 2 params → 200401404500503
GET
/api/3/sites/{id}/alerts/snmp
Site SNMP Alerts
getSiteSnmpAlerts 1 param → 200401404500503
POST
/api/3/sites/{id}/alerts/snmp
Site SNMP Alerts
createSiteSnmpAlert 1 param body → 201400401500503
PUT
/api/3/sites/{id}/alerts/snmp
Site SNMP Alerts
setSiteSnmpAlerts 1 param body → 200400401404500503
DELETE
/api/3/sites/{id}/alerts/snmp
Site SNMP Alerts
deleteAllSiteSnmpAlerts 1 param → 200401404500503
GET
/api/3/sites/{id}/alerts/snmp/{alertId}
Site SNMP Alert
getSiteSnmpAlert 2 params → 200401404500503
PUT
/api/3/sites/{id}/alerts/snmp/{alertId}
Site SNMP Alert
updateSiteSnmpAlert 2 params body → 200400401404500503
DELETE
/api/3/sites/{id}/alerts/snmp/{alertId}
Site SNMP Alert
deleteSiteSnmpAlert 2 params → 200401404500503
GET
/api/3/sites/{id}/alerts/syslog
Site Syslog Alerts
getSiteSyslogAlerts 1 param → 200401404500503
POST
/api/3/sites/{id}/alerts/syslog
Site Syslog Alerts
createSiteSyslogAlert 1 param body → 201400401500503
PUT
/api/3/sites/{id}/alerts/syslog
Site Syslog Alerts
setSiteSyslogAlerts 1 param body → 200400401404500503
DELETE
/api/3/sites/{id}/alerts/syslog
Site Syslog Alerts
deleteAllSiteSyslogAlerts 1 param → 200401404500503
GET
/api/3/sites/{id}/alerts/syslog/{alertId}
Site Syslog Alert
getSiteSyslogAlert 2 params → 200401404500503
PUT
/api/3/sites/{id}/alerts/syslog/{alertId}
Site Syslog Alert
updateSiteSyslogAlert 2 params body → 200400401404500503
DELETE
/api/3/sites/{id}/alerts/syslog/{alertId}
Site Syslog Alert
deleteSiteSyslogAlert 2 params → 200401404500503
DELETE
/api/3/sites/{id}/assets/{assetId}
Site Asset
removeAssetFromSite 2 params → 200401404500503
GET
/api/3/sites/{id}/discovery_connection
Site Discovery Connection
getSiteDiscoveryConnection 1 param → 200401404500503
PUT
/api/3/sites/{id}/discovery_connection
Site Discovery Connection
setSiteDiscoveryConnection 1 param body → 200400401404500503
GET
/api/3/sites/{id}/discovery_search_criteria
Site Discovery Search Criteria
getSiteDiscoverySearchCriteria 1 param → 200401404500503
PUT
/api/3/sites/{id}/discovery_search_criteria
Site Discovery Search Criteria
setSiteDiscoverySearchCriteria 1 param body → 200400401404500503
GET
/api/3/sites/{id}/excluded_asset_groups
Site Excluded Asset Groups
getExcludedAssetGroups 1 param → 200401404500503
PUT
/api/3/sites/{id}/excluded_asset_groups
Site Excluded Asset Groups
updateExcludedAssetGroups 1 param body → 200400401404500503
DELETE
/api/3/sites/{id}/excluded_asset_groups
Site Excluded Asset Groups
removeAllExcludedAssetGroups 1 param → 200401404500503
DELETE
/api/3/sites/{id}/excluded_asset_groups/{assetGroupId}
Site Excluded Asset Group
removeExcludedAssetGroup 2 params → 200401404500503
GET
/api/3/sites/{id}/excluded_targets
Site Excluded Targets
getExcludedTargets 1 param → 200401404500503
POST
/api/3/sites/{id}/excluded_targets
Site Excluded Targets
addExcludedTargets 1 param body → 201400401500503
PUT
/api/3/sites/{id}/excluded_targets
Site Excluded Targets
updateExcludedTargets 1 param body → 200400401404500503
DELETE
/api/3/sites/{id}/excluded_targets
Site Excluded Targets
removeExcludedTargets 1 param body → 200401404500503
GET
/api/3/sites/{id}/included_asset_groups
Site Included Asset Groups
getIncludedAssetGroups 1 param → 200401404500503
PUT
/api/3/sites/{id}/included_asset_groups
Site Included Asset Groups
updateIncludedAssetGroups 1 param body → 200400401404500503
DELETE
/api/3/sites/{id}/included_asset_groups
Site Included Asset Groups
removeAllIncludedAssetGroups 1 param → 200401404500503
DELETE
/api/3/sites/{id}/included_asset_groups/{assetGroupId}
Site Included Asset Group
removeIncludedAssetGroup 2 params → 200401404500503
GET
/api/3/sites/{id}/included_targets
Site Included Targets
getIncludedTargets 1 param → 200401404500503
POST
/api/3/sites/{id}/included_targets
Site Included Targets
addIncludedTargets 1 param body → 201400401500503
PUT
/api/3/sites/{id}/included_targets
Site Included Targets
updateIncludedTargets 1 param body → 200400401404500503
DELETE
/api/3/sites/{id}/included_targets
Site Included Targets
removeIncludedTargets 1 param body → 200401404500503
GET
/api/3/sites/{id}/organization
Site Organization Information
getSiteOrganization 1 param → 200401404500503
PUT
/api/3/sites/{id}/organization
Site Organization Information
updateSiteOrganization 1 param body → 200400401404500503
GET
/api/3/sites/{id}/scan_engine
Site Scan Engine
getSiteScanEngine 1 param → 200401404500503
PUT
/api/3/sites/{id}/scan_engine
Site Scan Engine
setSiteScanEngine 1 param body → 200400401404500503
GET
/api/3/sites/{id}/scan_schedules
Site Scan Schedules
getSiteScanSchedules 1 param → 200401404500503
POST
/api/3/sites/{id}/scan_schedules
Site Scan Schedules
createSiteScanSchedule 1 param body → 201400401500503
PUT
/api/3/sites/{id}/scan_schedules
Site Scan Schedules
setSiteScanSchedules 1 param body → 200400401404500503
DELETE
/api/3/sites/{id}/scan_schedules
Site Scan Schedules
deleteAllSiteScanSchedules 1 param → 200401404500503
GET
/api/3/sites/{id}/scan_schedules/{scheduleId}
Site Scan Schedule
getSiteScanSchedule 2 params → 200401404500503
PUT
/api/3/sites/{id}/scan_schedules/{scheduleId}
Site Scan Schedule
updateSiteScanSchedule 2 params body → 200400401404500503
DELETE
/api/3/sites/{id}/scan_schedules/{scheduleId}
Site Scan Schedule
deleteSiteScanSchedule 2 params → 200401404500503
GET
/api/3/sites/{id}/scan_template
Site Scan Template
getSiteScanTemplate 1 param → 200401404500503
PUT
/api/3/sites/{id}/scan_template
Site Scan Template
setSiteScanTemplate 1 param body → 200400401404500503
GET
/api/3/sites/{id}/shared_credentials
Assigned Shared Credentials
getSiteSharedCredentials 1 param → 200401404500503
PUT
/api/3/sites/{id}/shared_credentials/{credentialId}/enabled
Assigned Shared Credential Enablement
enableSharedCredentialOnSite 2 params body → 200400401404500503
GET
/api/3/sites/{id}/site_credentials
Site Scan Credentials
getSiteCredentials 1 param → 200401404500503
POST
/api/3/sites/{id}/site_credentials
Site Scan Credentials
createSiteCredential 1 param body → 201400401500503
PUT
/api/3/sites/{id}/site_credentials
Site Scan Credentials
setSiteCredentials 1 param body → 200400401404500503
DELETE
/api/3/sites/{id}/site_credentials
Site Scan Credentials
deleteAllSiteCredentials 1 param → 200401404500503
GET
/api/3/sites/{id}/site_credentials/{credentialId}
Site Scan Credential
getSiteCredential 2 params → 200401404500503
PUT
/api/3/sites/{id}/site_credentials/{credentialId}
Site Scan Credential
updateSiteCredential 2 params body → 200400401404500503
DELETE
/api/3/sites/{id}/site_credentials/{credentialId}
Site Scan Credential
deleteSiteCredential 2 params → 200401404500503
PUT
/api/3/sites/{id}/site_credentials/{credentialId}/enabled
Site Credential Enablement
enableSiteCredential 2 params body → 200400401404500503
GET
/api/3/sites/{id}/tags
Site Tags
getSiteTags 1 param → 200401404500503
PUT
/api/3/sites/{id}/tags
Site Tags
setSiteTags 1 param body → 200400401404500503
PUT
/api/3/sites/{id}/tags/{tagId}
Site Tag
addSiteTag 2 params → 201400401404500503
DELETE
/api/3/sites/{id}/tags/{tagId}
Site Tag
removeSiteTag 2 params → 200401404500503
GET
/api/3/sites/{id}/users
Site Users Access
getSiteUsers 1 param → 200401404500503
POST
/api/3/sites/{id}/users
Site Users Access
addSiteUser 1 param body → 201400401500503
PUT
/api/3/sites/{id}/users
Site Users Access
setSiteUsers 1 param body → 200400401404500503
DELETE
/api/3/sites/{id}/users/{userId}
Site User Access
removeSiteUser 2 params → 200401404500503
GET
/api/3/sites/{id}/web_authentication/html_forms
Web Authentication HTML Forms
getWebAuthHtmlForms 1 param → 200401404500503
GET
/api/3/sites/{id}/web_authentication/http_headers
Web Authentication HTTP Headers
getWebAuthHTTPHeaders 1 param → 200401404500503

Schemas 106

The contract defines 106 schemas that model the data the API accepts and returns. The most detailed are Asset (24 properties), ScanTemplate (18 properties), SoftwareCpe (13 properties), Service (13 properties). Each schema is shown below with its type and property counts.

ScanEvents
object
5 properties 4 required
ScanSchedule
object
12 properties 3 required
ScanTemplateDiscoveryPerformanceScanDelay
object
2 properties
LocalePreferences
object
3 properties
AssetGroup
object
9 properties 2 required
Resources_AssetGroup
object
2 properties
PageOf_Site
object
3 properties
ExcludedScanTargets
object
2 properties
UniqueId
object
2 properties 1 required
DynamicSite
object
1 property 1 required
Resources_SiteSharedCredential
object
2 properties
Address
object
2 properties
Vulnerabilities
object
4 properties
Alert
object
8 properties 3 required
OperatingSystemCpe
object
13 properties 1 required
ScanTemplateDiscoveryPerformance
object
5 properties
SnmpAlert
object
10 properties 5 required
ScanTemplate
object
18 properties
Tag
object
9 properties 2 required
Software
object
9 properties
SyslogAlert
object
9 properties 4 required
SoftwareCpe
object
13 properties 1 required
Resources_ScanSchedule
object
2 properties
SiteCreateResource
object
7 properties 1 required
ScanTemplateDiscoveryPerformanceTimeout
object
3 properties
ServiceUnavailableError
object
3 properties 1 required
UserRole
object
6 properties
ReferenceWith_SiteID_Link
object
2 properties
OperatingSystem
object
11 properties
ScanTemplateServiceDiscovery
object
3 properties
WebApplication
object
4 properties
SiteDiscoveryConnection
object
4 properties
Resources_WebFormAuthentication
object
2 properties
WebPage
object
3 properties
ScanTemplateVulnerabilityChecks
object
7 properties
Repeat
object
5 properties 2 required
IncludedAssetGroups
object
2 properties
ScanTargetsResource
object
2 properties
PageInfo
object
4 properties
Database
object
3 properties 1 required
Links
object
1 property
AuthenticationSource
object
5 properties
ScanTemplateServiceDiscoveryTcp
object
5 properties
Resources_Alert
object
2 properties
ScanTemplateVulnerabilityCheckCategories
object
3 properties
PageOf_Asset
object
3 properties
SiteSharedCredential
object
5 properties
Resources_SiteCredential
object
2 properties
Resources_User
object
2 properties
BadRequestError
object
3 properties 1 required
ScanTemplateDiscoveryPerformanceParallelism
object
2 properties
DiscoverySearchCriteria
object
3 properties
ScanTemplateDiscovery
object
3 properties
ExcludedAssetGroups
object
2 properties
ScanTemplateServiceDiscoveryUdp
object
4 properties
File
object
4 properties 2 required
AssetHistory
object
7 properties
IncludedScanTargets
object
2 properties
WebHeaderAuthentication
object
8 properties
SiteCredential
object
8 properties 2 required
StaticSite
object
4 properties
ReferenceWith_ScanScheduleID_Link
object
2 properties
ScanTemplateDatabase
object
4 properties
Resources_SmtpAlert
object
2 properties
VulnerabilityCheckType
object
3 properties
ScanEngine
object
12 properties 4 required
SwaggerDiscoverySearchCriteriaFilter
object
6 properties
ScanScope
object
2 properties
AssetVulnerabilities
object
6 properties
Telnet
object
6 properties
SiteUpdateResource
object
6 properties 4 required
CreatedReference_CredentialID_Link
object
2 properties
Account
object
1 property
ReferenceWith_UserID_Link
object
2 properties
VulnerabilityEvents
object
4 properties 4 required
Service
object
13 properties 2 required
ScanTemplateAssetDiscovery
object
9 properties
Resources_SnmpAlert
object
2 properties
Site
object
13 properties
SearchCriteria
object
2 properties
ScanTemplateVulnerabilityCheckIndividual
object
3 properties
Resources_WebHeaderAuthentication
object
2 properties
Resources_Tag
object
2 properties
SiteOrganization
object
12 properties
Asset
object
24 properties
ScanTemplateWebSpiderPaths
object
3 properties
SwaggerSearchCriteriaFilter
object
6 properties
Link
object
2 properties
ReferenceWith_AlertID_Link
object
2 properties
ScanTemplateWebSpider
object
8 properties
GroupAccount
object
2 properties 1 required
User
object
10 properties 2 required
ScheduledScanTargets
object
4 properties
HostName
object
2 properties 1 required
ScanTemplateWebSpiderPatterns
object
2 properties
Resources_SyslogAlert
object
2 properties
InternalServerError
object
3 properties 1 required
NotFoundError
object
3 properties 1 required
ScanTemplateWebSpiderPerformance
object
9 properties
UserAccount
object
3 properties
ScanTemplateDiscoveryPerformancePacketsRate
object
3 properties
WebFormAuthentication
object
8 properties
SmtpAlert
object
12 properties 5 required
Policy
object
4 properties
Configuration
object
2 properties 1 required
UnauthorizedError
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapid7-site-api-openapi.yml Raw ↑

Other APIs Rapid7 publishes across the network.

Rapid7 InsightVM Cloud API
AE Profile APIs.io
Rapid7 Insight Platform API
AE Profile APIs.io
Rapid7 InsightIDR API
AE Profile APIs.io
Rapid7 Accounts API
AE Profile APIs.io
Rapid7 Administration API
AE Profile APIs.io
Rapid7 Apps API
AE Profile APIs.io
Rapid7 Asset API
AE Profile APIs.io
Rapid7 Asset Discovery API
AE Profile APIs.io
Rapid7 Asset Group API
AE Profile APIs.io
Rapid7 Assets API
AE Profile APIs.io
Rapid7 Attachments API
AE Profile APIs.io
Rapid7 Attack Templates API
AE Profile APIs.io
#Site
← Back to R APIs
API Details
ID
rapid7:rapid7-site-api
Base URL
https://us.api.insight.rapid7.com/vm/v4
Docs
https://help.rapid7.com/insightvm/en-us/api/api.html
Provider
Rapid7
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=rapid7-site-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/rapid7-site-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Rapid7 Site API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.