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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

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.1.0, at version v1.

Requests are made against a single base URL, https://[region].api.insight.rapid7.com/ias/v1.

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.1.0
API Version
v1
Base URL
https://us.api.insight.rapid7.com/vm/v4
Resource Areas
1

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 1 param → 201400401500503
GET
/api/3/sites/{id}
Site
getSite 1 param → 200401404500503
PUT
/api/3/sites/{id}
Site
updateSite 2 params → 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 2 params → 201400401500503
PUT
/api/3/sites/{id}/alerts/smtp
Site SMTP Alerts
setSiteSmtpAlerts 2 params → 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 3 params → 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 2 params → 201400401500503
PUT
/api/3/sites/{id}/alerts/snmp
Site SNMP Alerts
setSiteSnmpAlerts 2 params → 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 3 params → 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 2 params → 201400401500503
PUT
/api/3/sites/{id}/alerts/syslog
Site Syslog Alerts
setSiteSyslogAlerts 2 params → 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 3 params → 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 2 params → 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 2 params → 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 2 params → 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 2 params → 201400401500503
PUT
/api/3/sites/{id}/excluded_targets
Site Excluded Targets
updateExcludedTargets 2 params → 200400401404500503
DELETE
/api/3/sites/{id}/excluded_targets
Site Excluded Targets
removeExcludedTargets 2 params → 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 2 params → 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 2 params → 201400401500503
PUT
/api/3/sites/{id}/included_targets
Site Included Targets
updateIncludedTargets 2 params → 200400401404500503
DELETE
/api/3/sites/{id}/included_targets
Site Included Targets
removeIncludedTargets 2 params → 200401404500503
GET
/api/3/sites/{id}/organization
Site Organization Information
getSiteOrganization 1 param → 200401404500503
PUT
/api/3/sites/{id}/organization
Site Organization Information
updateSiteOrganization 2 params → 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 2 params → 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 2 params → 201400401500503
PUT
/api/3/sites/{id}/scan_schedules
Site Scan Schedules
setSiteScanSchedules 2 params → 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 3 params → 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 2 params → 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 3 params → 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 2 params → 201400401500503
PUT
/api/3/sites/{id}/site_credentials
Site Scan Credentials
setSiteCredentials 2 params → 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 3 params → 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 3 params → 200400401404500503
GET
/api/3/sites/{id}/tags
Site Tags
getSiteTags 1 param → 200401404500503
PUT
/api/3/sites/{id}/tags
Site Tags
setSiteTags 2 params → 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 2 params → 201400401500503
PUT
/api/3/sites/{id}/users
Site Users Access
setSiteUsers 2 params → 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), OperatingSystemCpe (13 properties). Each schema is shown below with its type and property counts.

File
object
4 properties 2 required
ScanEngine
object
12 properties 4 required
Resources«SiteCredential»
object
2 properties
AssetHistory
object
7 properties
NotFoundError
object
3 properties 1 required
ReferenceWith«ScanScheduleID,Link»
object
2 properties
Database
object
3 properties 1 required
Resources«User»
object
2 properties
WebApplication
object
4 properties
SiteSharedCredential
object
5 properties
ScanTemplateVulnerabilityCheckCategories
object
3 properties
ScanTargetsResource
object
2 properties
ScanTemplateAssetDiscovery
object
9 properties
ScanTemplateDiscoveryPerformancePacketsRate
object
3 properties
SiteCreateResource
object
7 properties 1 required
ScanEvents
object
5 properties 4 required
IncludedScanTargets
object
2 properties
BadRequestError
object
3 properties 1 required
ScanTemplateWebSpiderPaths
object
3 properties
PageInfo
object
4 properties
AuthenticationSource
object
5 properties
Configuration
object
2 properties 1 required
UniqueId
object
2 properties 1 required
Resources«Tag»
object
2 properties
ScanTemplateDiscoveryPerformanceParallelism
object
2 properties
SwaggerSearchCriteriaFilter
object
6 properties
Account
object
1 property
UserRole
object
6 properties
Resources«ScanSchedule»
object
2 properties
PageOf«Asset»
object
3 properties
Resources«SnmpAlert»
object
2 properties
SiteUpdateResource
object
6 properties 4 required
Site
object
13 properties
Links
object
1 property
HostName
object
2 properties 1 required
Resources«WebFormAuthentication»
object
2 properties
CreatedReference«CredentialID,Link»
object
2 properties
Repeat
object
5 properties 2 required
ScanTemplateServiceDiscoveryTcp
object
5 properties
SnmpAlert
object
10 properties 5 required
ServiceUnavailableError
object
3 properties 1 required
IncludedAssetGroups
object
2 properties
ScanTemplate
object
18 properties
Alert
object
8 properties 3 required
AssetGroup
object
9 properties 2 required
SiteOrganization
object
12 properties
Telnet
object
6 properties
SiteCredential
object
8 properties 2 required
ScanTemplateServiceDiscovery
object
3 properties
Policy
object
4 properties
ScanTemplateDiscovery
object
3 properties
Tag
object
9 properties 2 required
ScanTemplateWebSpiderPatterns
object
2 properties
AssetVulnerabilities
object
6 properties
SoftwareCpe
object
13 properties 1 required
DiscoverySearchCriteria
object
3 properties
Resources«Alert»
object
2 properties
GroupAccount
object
2 properties 1 required
SearchCriteria
object
2 properties
Address
object
2 properties
User
object
10 properties 2 required
ScanTemplateDiscoveryPerformance
object
5 properties
ScanTemplateWebSpiderPerformance
object
9 properties
ScanSchedule
object
12 properties 3 required
LocalePreferences
object
3 properties
Resources«SiteSharedCredential»
object
2 properties
Software
object
9 properties
ReferenceWith«UserID,Link»
object
2 properties
PageOf«Site»
object
3 properties
ScanScope
object
2 properties
StaticSite
object
4 properties
DynamicSite
object
1 property 1 required
WebFormAuthentication
object
8 properties
ScanTemplateDiscoveryPerformanceTimeout
object
3 properties
ScanTemplateServiceDiscoveryUdp
object
4 properties
Service
object
13 properties 2 required
ScanTemplateWebSpider
object
8 properties
OperatingSystemCpe
object
13 properties 1 required
SyslogAlert
object
9 properties 4 required
ExcludedScanTargets
object
2 properties
OperatingSystem
object
11 properties
SiteDiscoveryConnection
object
4 properties
InternalServerError
object
3 properties 1 required
Resources«AssetGroup»
object
2 properties
ExcludedAssetGroups
object
2 properties
Resources«WebHeaderAuthentication»
object
2 properties
ReferenceWith«SiteID,Link»
object
2 properties
ScanTemplateVulnerabilityChecks
object
7 properties
ScanTemplateDatabase
object
4 properties
VulnerabilityEvents
object
4 properties 4 required
Resources«SmtpAlert»
object
2 properties
ScheduledScanTargets
object
4 properties
UserAccount
object
3 properties
WebHeaderAuthentication
object
8 properties
Resources«SyslogAlert»
object
2 properties
ReferenceWith«AlertID,Link»
object
2 properties
UnauthorizedError
object
3 properties 1 required
Vulnerabilities
object
4 properties
VulnerabilityCheckType
object
3 properties
SwaggerDiscoverySearchCriteriaFilter
object
6 properties
ScanTemplateDiscoveryPerformanceScanDelay
object
2 properties
WebPage
object
3 properties
ScanTemplateVulnerabilityCheckIndividual
object
3 properties
Asset
object
24 properties
SmtpAlert
object
12 properties 5 required
Link
object
2 properties

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