rapid7/insightvm_content_service repository overview

⁠Base image for the Rapid7 InsightVM Content Service.

This document describes the InsightVM Content Service.

⁠InsightVM Content Service Overview

By default the service does not load all resources into memory. Instead, the service will load and cache resources as they are requested. Response times can fluctuate as requested resources are loaded and cached, and response times will be different if a requested resource is cached versus when a requested resource is loaded and cached.

⁠System Resource Recommendations

⁠System Resource Requirement Estimations

⁠CPU Utilization Estimation

⁠Memory Utilization Estimation

Memory utilization will grow over time as new content is added. The size of requested resources will influence memory utilization.

⁠Disk Utilization Estimation

Disk utilization will grow over time as new content is added.

The service will read from disk when a resource is not cached. The amount and size of reads from disk will decrease as resources are cached until no more reads from disk are required.

⁠Bandwidth Utilization Estimation

• Minimum The amount of traffic if the smallest resource was requested in all requests.
• Average The amount of traffic if an average size resource was requested in all requests.
• Minimum The amount of traffic if the largest resource was requested in all requests.
• BPS Bytes Per Second
• KBPS Kilobytes Per Second
• KBPS Megabytes Per Second

⁠Solutions

⁠Vulnerabilities

⁠Network Requirements

⁠Listens on specified network port(s)

• 8081/TCP

The InsightVM Content Service container listens on TCP port 8081 at runtime for HTTP client communication. The port is not published by default. To publish the port when running the container, use the -p flag on docker run to publish and map one or more ports, or the -P flag to publish all exposed ports and map them to high-order ports.

⁠InsightVM Content Service Application Programming Interface (API) Overview

This section describes the InsightVM Content Service Application Programming Interface (API) Version 1. Unless noted otherwise this API accepts and produces the application/xml media type.

⁠Versioning

Versioning is specified in the URL and the base path of this API is: http://<host>:<port>/api/<version>/

⁠Resources

⁠Instances

An instance resource is a "leaf" level resource that may be retrieved, optionally nested within a collection resource. Instance resources are usually retrievable with opaque identifiers.

The resource path for instance resources follows the convention: /api/1/{resource_name}/{instance_id}

⁠Verbs

The following HTTP operations are supported throughout this API. The general usage of the operation and both its failure and success status codes are outlined below.

⁠Instance Resources

⁠GET

Retrieves the details of a specific resource by its identifier. The details retrieved can be controlled through property selection and property views. The content of the resource is returned within the body of the response in the acceptable media type.

⁠Responses

The following response statuses may be returned by this API.

⁠InsightVM Content Service Application Programming Interface (API)

⁠Solution

⁠GET /api/1/solutions/{id}

Returns the details for a solution that can remediate one or more vulnerabilities.

⁠Path Parameters

⁠Responses

⁠Vulnerability

⁠GET /api/1/vulnerabilities/{id}

Returns the details for a vulnerability.

⁠Path Parameters

⁠Responses