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

Rapid7 Administration API

Provides access administrative operations and procedures.

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

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

This API exposes 6 operations across 5 paths, and defines 44 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.

6 operations 5 paths 44 schemas 4 GET2 POST

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 6

Across 5 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Administration 6

Provides access administrative operations and procedures.

POST
/api/3/administration/commands
Console Commands
executeCommand 1 param → 200400401500503
GET
/api/3/administration/info
Information
getInfo → 200401404500503
GET
/api/3/administration/license
License
getLicense → 200401404500503
POST
/api/3/administration/license
License
activateLicense 2 params → 200400401500503
GET
/api/3/administration/properties
Properties
getProperties → 200401404500503
GET
/api/3/administration/settings
Settings
getSettings → 200401404500503

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are Info (14 properties), Settings (14 properties), Features (13 properties), License (8 properties). Each schema is shown below with its type and property counts.

UpdateId
object
2 properties
DatabaseSettings
object
7 properties
InstallationTotalSize
object
2 properties
LicensePolicyScanningBenchmarks
object
5 properties
AuthenticationSettings
object
2 properties
UpdateInfo
object
4 properties
Info
object
14 properties
NotFoundError
object
3 properties 1 required
VersionInfo
object
5 properties
EnvironmentProperties
object
2 properties
RiskModifierSettings
object
5 properties
InternalServerError
object
3 properties 1 required
Features
object
13 properties
Settings
object
14 properties
LicenseLimits
object
4 properties
RiskSettings
object
3 properties
JVMInfo
object
5 properties
Links
object
1 property
ScanSettings
object
6 properties
ScanSize
object
2 properties
DatabaseConnectionSettings
object
3 properties
DiskTotal
object
2 properties
ReportSize
object
2 properties
UnauthorizedError
object
3 properties 1 required
DiskFree
object
2 properties
ServiceUnavailableError
object
3 properties 1 required
WebSettings
object
4 properties
License
object
8 properties
LicenseReporting
object
3 properties
ConsoleCommandOutput
object
2 properties
MemoryInfo
object
2 properties
LicenseScanning
object
5 properties
MemoryTotal
object
2 properties
DiskInfo
object
3 properties
UpdateSettings
object
3 properties
BadRequestError
object
3 properties 1 required
CPUInfo
object
2 properties
BackupsSize
object
2 properties
MemoryFree
object
2 properties
SmtpSettings
object
3 properties
LicensePolicyScanning
object
2 properties
InstallSize
object
6 properties
DatabaseSize
object
2 properties
Link
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapid7-administration-api-openapi.yml Raw ↑

Other APIs Rapid7 publishes across the network.

Rapid7 InsightVM Cloud API
Rapid7 Insight Platform API
Rapid7 InsightIDR API
Rapid7 Accounts API
Rapid7 Apps API
Rapid7 Asset API
Rapid7 Asset Discovery API
Rapid7 Asset Group API
Rapid7 Assets API
Rapid7 Attachments API
Rapid7 Attack Templates API
Rapid7 Blackouts API