---
agentTools:
  projectIndex: https://help.logichub.com/llms.txt
---

# Nexpose

Version: 2.0.0

Nexpose, Rapid7's on-premise option for vulnerability management software, monitors exposures in real-time and adapts to new threats with fresh data, ensuring you can always act at the moment of impact.

# Connect Nexpose with LogicHub

1. Navigate to **Automations** > **Integrations**.
2. Search for **Nexpose**.
3. Click **Details**, then the **+** icon. Enter the required information in the following fields.
   * **Label**: Enter a connection name.
   * **Reference Values**: Define variables here to templatize integration connections and actions. For example, you can use <https://www.{{hostname}}.com> where, hostname is a variable defined in this input. For more information on how to add data, see ['Add Data' Input Type for Integrations](add-an-integration-connection#add-data-input-type-for-integrations).
   * **Verify SSL**: Select option to verify connecting server's SSL certificate (Default is Verify SSL Certificate).
   * **Remote Agent**: Run this integration using the LogicHub Remote Agent.
   * **Nexpose Server**: Server name for your Nexpose instance.
   * **Nexpose Server Port**: Server port for your Nexpose instance.
   * **Username**: Username for your Nexpose instance.
   * **Password**: Password for your Nexpose instance.
4. After you've entered all the details, click **Connect**.

# Actions for Nexpose

## Vulnerability Scan

Scan of a given IP address for vulnerabilities.

### Input Field

[block:parameters]
{
  "data": {
    "h-0": "Input Name",
    "h-1": "Description",
    "h-2": "Required",
    "0-0": "Column name",
    "0-1": "Column name from parent table to lookup value for. Table should have only 1 row.",
    "0-2": "Required"
  },
  "cols": 3,
  "rows": 1
}
[/block]

## Get Scan Report

Retrieve the report of the latest scan.

### Input Field

Choose a connection that you have previously created to complete the connection.

## Find Affected Hosts

Find hosts affected by a given CVE number.

### Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

[block:parameters]
{
  "data": {
    "h-0": "Input Name",
    "h-1": "Description",
    "h-2": "Required",
    "0-0": "Column name",
    "0-1": "Column name from parent table containing CVE Number.",
    "0-2": "Required"
  },
  "cols": 3,
  "rows": 1
}
[/block]

## Retrieve All Scans

Find all scans that are currently either active or inactive.

### Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

[block:parameters]
{
  "data": {
    "h-0": "Input Name",
    "h-1": "Description",
    "h-2": "Required",
    "0-0": "Scan type",
    "0-1": "Type of scan (Default is Active).",
    "0-2": "Required"
  },
  "cols": 3,
  "rows": 1
}
[/block]

## Stop Scan

Stop scan with given ID.

### Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

[block:parameters]
{
  "data": {
    "h-0": "Input Name",
    "h-1": "Description",
    "h-2": "Required",
    "0-0": "Column name",
    "0-1": "Column containing Scan ID.",
    "0-2": "Required"
  },
  "cols": 3,
  "rows": 1
}
[/block]

## Create Site

Creates a new site with the specified configuration. This uses the v3 API of the Nexpose.

### Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

[block:parameters]
{
  "data": {
    "h-0": "Input Name",
    "h-1": "Description",
    "h-2": "Required",
    "0-0": "Name",
    "0-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the name of site. Name must be unique.",
    "0-2": "Required",
    "1-0": "Description",
    "1-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the description of site.",
    "1-2": "Optional",
    "2-0": "Engine Id",
    "2-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the identifier of a scan engine. Default scan engine in your Nexpose account will be selected when not specified.",
    "2-2": "Optional",
    "3-0": "Template Id",
    "3-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the identifier of a scan template. Default scan template in your nexpose account will be selected when not specified.",
    "3-2": "Optional",
    "4-0": "Included Targets",
    "4-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) json containing the addresses to be included in the site's scan. Eg {\"addresses\": [\"string\"],\"links\": [{\"href\": \"https://hostname:3780/api/3/...\",\"rel\": \"self\"}]}",
    "4-2": "Required",
    "5-0": "Excluded Targets",
    "5-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) json containing the addresses to be excluded in the site's scan. Eg {\"addresses\": [\"string\"],\"links\": [{\"href\": \"https://hostname:3780/api/3/...\",\"rel\": \"self\"}]}",
    "5-2": "Optional"
  },
  "cols": 3,
  "rows": 6
}
[/block]

### Output

A JSON object containing row of result:

[block:code]
{
  "codes": [
    {
      "code": "{\n\t\"has_error\": false,\n\t\"id\": 38,\n\t\"links\": [{\n\t\t\"href\": \"https://localhost:3780/api/3/sites\",\n\t\t\"rel\": \"self\"\n\t}, {\n\t\t\"href\": \"https://localhost:3780/api/3/sites/38\",\n\t\t\"rel\": \"Site\"\n\t}],\n\t\"error\": null\n}",
      "language": "json"
    }
  ]
}
[/block]

## Delete Site

Deletes a specific site. This uses the v3 API of the Nexpose.

### Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

[block:parameters]
{
  "data": {
    "h-0": "Input Name",
    "h-1": "Description",
    "h-2": "Required",
    "0-0": "Site Id",
    "0-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the site Id to be deleted.",
    "0-2": "Required"
  },
  "cols": 3,
  "rows": 1
}
[/block]

### Output

A JSON object containing row of result:

[block:code]
{
  "codes": [
    {
      "code": "{\n\t\"has_error\": false,\n\t\"links\": [{\n\t\t\"href\": \"https://localhost:3780/api/3/sites/38\",\n\t\t\"rel\": \"self\"\n\t}],\n\t\"error\": null\n}",
      "language": "json"
    }
  ]
}
[/block]

## Create Site Scan

Creates a new scan schedule for the specified site. This uses the v3 API of the Nexpose.

### Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

[block:parameters]
{
  "data": {
    "h-0": "Input Name",
    "h-1": "Description",
    "h-2": "Required",
    "0-0": "Site Id",
    "0-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the id of the Site for which Scan Schedule has to be created.",
    "0-2": "Required",
    "1-0": "Duration",
    "1-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the maximum duration the scheduled scan is allowed to run.For example, 'P5DT10H30M' represents a duration of '5 days, 10 hours, and 30 minutes'.",
    "1-2": "Required",
    "2-0": "Enabled",
    "2-1": "The boolean value indicating whether the scan schedule is enabled. Default is 'False'.",
    "2-2": "Optional",
    "3-0": "onScanRepeat",
    "3-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the desired behavior of a repeating scheduled scan when the previous scan was paused due to reaching is maximum duration. Supported values are 'restart-scan' and 'resume-scan'.",
    "3-2": "Required",
    "4-0": "Repeat Day of Week",
    "4-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the day of the week the scheduled task should repeat. This property only applies to schedules with a 'Repeat Every' value of 'day-of-month'.",
    "4-2": "Optional",
    "5-0": "Repeat Every",
    "5-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the frequency schedule repeats. Each value represents a different unit of time and is used in conjunction with the property 'Repeat Interval'. Supported values are 'hour', 'day', 'week', 'date-of-month', 'day-of-month'\".",
    "5-2": "Required",
    "6-0": "Repeat Interval",
    "6-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) number containing the interval time in which schedule should repeat. The is depends on the value set in 'Repeat Every'. For example, if the value in property every is set to 'day' and interval is set to 2, then the schedule will repeat every 2 days.",
    "6-2": "Required",
    "7-0": "Repeat Last Day of Month",
    "7-1": "The boolean value to enable repeating last day of month. Default is False.",
    "7-2": "Optional",
    "8-0": "Repeat Week of Month",
    "8-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the week of the month the scheduled task should repeat. For This property only applies to schedules with a 'Repeat Every' value of 'day-of-month'. Each week of the month is counted in 7-day increments. For example, week 1 consists of days 1-7 of the month while week 2 consists of days 8-14 of the month and so forth.",
    "8-2": "Optional",
    "9-0": "Scan Engine Id",
    "9-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the identifier of the scan engine to be used for this scan schedule. If not set, the site's assigned scan engine will be used.",
    "9-2": "Optional",
    "10-0": "Scan Template Id",
    "10-2": "Optional",
    "11-2": "Required",
    "10-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the identifier of the scan template to be used for this scan schedule. If not set, the site's assigned scan template will be used.",
    "11-0": "Start",
    "11-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the scheduled start date and time. Date is represented in ISO 8601 format (Example: '2022-03-28T04:31:56Z'). Repeating schedules will determine the next schedule to begin based on this date and time."
  },
  "cols": 3,
  "rows": 12
}
[/block]

### Output

A JSON object containing row of result:

[block:code]
{
  "codes": [
    {
      "code": "{\n\t\"has_error\": false,\n\t\"id\": 1,\n\t\"links\": [{\n\t\t\"href\": \"https://localhost:3780/api/3/sites/38/scan_schedules\",\n\t\t\"rel\": \"self\"\n\t}, {\n\t\t\"href\": \"https://localhost:3780/api/3/sites/38\",\n\t\t\"rel\": \"Site\"\n\t}],\n\t\"error\": null\n}",
      "language": "json"
    }
  ]
}
[/block]

## Delete Site Scan

Deletes all scan schedules from the site. This uses the v3 API of the Nexpose.

### Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

[block:parameters]
{
  "data": {
    "h-0": "Input Name",
    "h-1": "Description",
    "h-2": "Required",
    "0-0": "Site Id",
    "0-1": "[Jinja-templated](https://help.logichub.com/docs/jinja-template) text containing the identifier of the Site.",
    "0-2": "Required"
  },
  "cols": 3,
  "rows": 1
}
[/block]

### Output

A JSON object containing row of result:

[block:code]
{
  "codes": [
    {
      "code": "{\n\t\"has_error\": false,\n\t\"links\": [{\n\t\t\"href\": \"https://localhost:3780/api/3/sites/38/scan_schedules\",\n\t\t\"rel\": \"self\"\n\t}],\n\t\"error\": null\n}",
      "language": "json"
    }
  ]
}
[/block]

# Release Notes

* `v2.0.0` - Updated architecture to support IO via filesystem
* `v1.1.3` - Made `Repeat Day of Week` and `Repeat Week of Month` fields as optional fields.
* `v1.1.2` - Added 4 new actions `Create Site`, `Delete Site`, `Create Site Scan` and `Delete Site Scan`.