Skip to content
This repository was archived by the owner on Sep 10, 2024. It is now read-only.

Commit 914abd6

Browse files
Merge pull request #29 from rapid7/release/6.6.10
Update generated library to version: 6.6.10
2 parents 41c4de0 + a12ee46 commit 914abd6

File tree

279 files changed

+1483
-883
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

279 files changed

+1483
-883
lines changed

.swagger-codegen/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.4.0
1+
2.4.12

api-files/console-swagger.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/Agent.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Agent
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**addresses** | [**list[Address]**](Address.md) | All addresses discovered on the asset. | [optional]
7+
**agent_id** | **str** | The identifier of the agent. | [optional]
8+
**assessed_for_policies** | **bool** | Whether the asset has been assessed for policies at least once. | [optional]
9+
**assessed_for_vulnerabilities** | **bool** | Whether the asset has been assessed for vulnerabilities at least once. | [optional]
10+
**configurations** | [**list[Configuration]**](Configuration.md) | Configuration key-values pairs enumerated on the asset. | [optional]
11+
**databases** | [**list[Database]**](Database.md) | The databases enumerated on the asset. | [optional]
12+
**files** | [**list[File]**](File.md) | The files discovered with searching on the asset. | [optional]
13+
**history** | [**list[AssetHistory]**](AssetHistory.md) | The history of changes to the asset over time. | [optional]
14+
**host_name** | **str** | The primary host name (local or FQDN) of the asset. | [optional]
15+
**host_names** | [**list[HostName]**](HostName.md) | All host names or aliases discovered on the asset. | [optional]
16+
**id** | **int** | The identifier of the asset. | [optional]
17+
**ids** | [**list[UniqueId]**](UniqueId.md) | Unique identifiers found on the asset, such as hardware or operating system identifiers. | [optional]
18+
**ip** | **str** | The primary IPv4 or IPv6 address of the asset. | [optional]
19+
**last_assessed_for_vulnerabilities** | **str** | The time the last vulnerability assessment occured. |
20+
**links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional]
21+
**mac** | **str** | The primary Media Access Control (MAC) address of the asset. The format is six groups of two hexadecimal digits separated by colons. | [optional]
22+
**os** | **str** | The full description of the operating system of the asset. | [optional]
23+
**os_fingerprint** | [**OperatingSystem**](OperatingSystem.md) | The details of the operating system of the asset. | [optional]
24+
**raw_risk_score** | **float** | The base risk score of the asset. | [optional]
25+
**risk_score** | **float** | The risk score (with criticality adjustments) of the asset. | [optional]
26+
**services** | [**list[Service]**](Service.md) | The services discovered on the asset. | [optional]
27+
**software** | [**list[Software]**](Software.md) | The software discovered on the asset. | [optional]
28+
**type** | **str** | The type of asset. | [optional]
29+
**user_groups** | [**list[GroupAccount]**](GroupAccount.md) | The group accounts enumerated on the asset. | [optional]
30+
**users** | [**list[UserAccount]**](UserAccount.md) | The user accounts enumerated on the asset. | [optional]
31+
**vulnerabilities** | [**AssetVulnerabilities**](AssetVulnerabilities.md) | Summary information for vulnerabilities on the asset. | [optional]
32+
33+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
34+
35+

docs/AssetGroupApi.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Method | HTTP request | Description
99
[**add_asset_to_asset_group**](AssetGroupApi.md#add_asset_to_asset_group) | **PUT** /api/3/asset_groups/{id}/assets/{assetId} | Asset Group Asset
1010
[**create_asset_group**](AssetGroupApi.md#create_asset_group) | **POST** /api/3/asset_groups | Asset Groups
1111
[**delete_asset_group**](AssetGroupApi.md#delete_asset_group) | **DELETE** /api/3/asset_groups/{id} | Asset Group
12+
[**get_agents**](AssetGroupApi.md#get_agents) | **GET** /api/3/agents | Agents
1213
[**get_asset_group**](AssetGroupApi.md#get_asset_group) | **GET** /api/3/asset_groups/{id} | Asset Group
1314
[**get_asset_group_assets**](AssetGroupApi.md#get_asset_group_assets) | **GET** /api/3/asset_groups/{id}/assets | Asset Group Assets
1415
[**get_asset_group_search_criteria**](AssetGroupApi.md#get_asset_group_search_criteria) | **GET** /api/3/asset_groups/{id}/search_criteria | Asset Group Search Criteria
@@ -273,6 +274,58 @@ No authorization required
273274

274275
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
275276

277+
# **get_agents**
278+
> PageOfAgent get_agents(page=page, size=size, sort=sort)
279+
280+
Agents
281+
282+
Returns the details for all agents.
283+
284+
### Example
285+
```python
286+
from __future__ import print_function
287+
import time
288+
import rapid7vmconsole
289+
from rapid7vmconsole.rest import ApiException
290+
from pprint import pprint
291+
292+
# create an instance of the API class
293+
api_instance = rapid7vmconsole.AssetGroupApi()
294+
page = 0 # int | The index of the page (zero-based) to retrieve. (optional) (default to 0)
295+
size = 10 # int | The number of records per page to retrieve. (optional) (default to 10)
296+
sort = ['sort_example'] # list[str] | The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters. (optional)
297+
298+
try:
299+
# Agents
300+
api_response = api_instance.get_agents(page=page, size=size, sort=sort)
301+
pprint(api_response)
302+
except ApiException as e:
303+
print("Exception when calling AssetGroupApi->get_agents: %s\n" % e)
304+
```
305+
306+
### Parameters
307+
308+
Name | Type | Description | Notes
309+
------------- | ------------- | ------------- | -------------
310+
**page** | **int**| The index of the page (zero-based) to retrieve. | [optional] [default to 0]
311+
**size** | **int**| The number of records per page to retrieve. | [optional] [default to 10]
312+
**sort** | [**list[str]**](str.md)| The criteria to sort the records by, in the format: `property[,ASC|DESC]`. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters. | [optional]
313+
314+
### Return type
315+
316+
[**PageOfAgent**](PageOfAgent.md)
317+
318+
### Authorization
319+
320+
No authorization required
321+
322+
### HTTP request headers
323+
324+
- **Content-Type**: application/json
325+
- **Accept**: application/json;charset=UTF-8
326+
327+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
328+
276329
# **get_asset_group**
277330
> AssetGroup get_asset_group(id)
278331

docs/AssetHistory.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
**_date** | **str** | The date the asset information was collected or changed. | [optional]
77
**description** | **str** | Additional information describing the change. | [optional]
88
**scan_id** | **int** | If a scan-oriented change, the identifier of the corresponding scan the asset was scanned in. | [optional]
9-
**type** | **str** | The type of change. May be one of: | Type | Source of Data | | ----------------------------------- | ----------------------------------------------------------- | | `ASSET-IMPORT`, `EXTERNAL-IMPORT` | External source such as the API | | `EXTERNAL-IMPORT-APPSPIDER` | Rapid7 InsightAppSec (previously known as AppSpider) | | `SCAN` | Scan engine scan | | `ACTIVE-SYNC` | ActiveSync | | `SCAN-LOG-IMPORT` | Manual import of a scan log | | `VULNERABILITY_EXCEPTION_APPLIED` | Vulnerability exception applied | | `VULNERABILITY_EXCEPTION_UNAPPLIED` | Vulnerability exception unapplied | | [optional]
9+
**type** | **str** | The type of change. May be one of: | Type | Source of Data | | ----------------------------------- | ----------------------------------------------------------- | | `ASSET-IMPORT`, `EXTERNAL-IMPORT` | External source such as the API | | `EXTERNAL-IMPORT-APPSPIDER` | Rapid7 InsightAppSec (previously known as AppSpider) | | `SCAN` | Scan engine scan | | `AGENT-IMPORT` | Rapid7 Insight Agent | | `ACTIVE-SYNC` | ActiveSync | | `SCAN-LOG-IMPORT` | Manual import of a scan log | | `VULNERABILITY_EXCEPTION_APPLIED` | Vulnerability exception applied | | `VULNERABILITY_EXCEPTION_UNAPPLIED` | Vulnerability exception unapplied | | [optional]
1010
**user** | **str** | If a vulnerability exception change, the login name of the user that performed the operation. | [optional]
1111
**version** | **int** | The version number of the change (a chronological incrementing number starting from 1). | [optional]
1212
**vulnerability_exception_id** | **int** | If a vulnerability exception change, the identifier of the vulnerability exception that caused the change. | [optional]

docs/AssetTag.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
**risk_modifier** | **object** | The amount to adjust risk of an asset tagged with this tag. | [optional]
1212
**search_criteria** | [**SearchCriteria**](SearchCriteria.md) | | [optional]
1313
**source** | **str** | The source of the tag. | [optional]
14-
**sources** | [**list[TagAssetSource]**](TagAssetSource.md) | The source(s) by which a tag is applied to an asset. | [optional]
14+
**sources** | [**list[TagAssetSource]**](TagAssetSource.md) | The source(s) by which a tag is-applied to an asset. | [optional]
1515
**type** | **str** | The type of the tag. |
1616

1717
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/DatabaseConnectionSettings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**maximum_administration_pool_size** | **int** | The maximum number of administrative connections in the connection pool. -1 means unlimited. | [optional]
7-
**maximum_pool_size** | **int** | ${settings.database.connection.max} | [optional]
7+
**maximum_pool_size** | **int** | The maximum number of connections in the connection pool. -1 means unlimited. | [optional]
88
**maximum_prepared_statement_pool_size** | **int** | The maximum number of prepared statements in the prepared statement pool. -1 means unlimited. | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/DiscoveryConnection.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**access_key_id** | **str** | The AWS credential access key identifier (only used for the AWS connection). | [optional]
7-
**address** | **str** | ${discovery.connection.address} | [optional]
7+
**address** | **str** | The address used to connect to the discovery connection source. | [optional]
88
**arn** | **str** | The AWS credential ARN (only used for the AWS connection). | [optional]
99
**aws_session_name** | **str** | The AWS credential session name (only used for the AWS connection). | [optional]
1010
**connection_type** | **str** | The type of the discovery connection. | [optional]
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
1616
**ldap_server** | **str** | The LDAP server to connect to. | [optional]
1717
**links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional]
1818
**name** | **str** | The discovery connection name. | [optional]
19-
**port** | **int** | The address used to connect to the discovery connection source. | [optional]
19+
**port** | **int** | The port used to connect to the discovery connection source. | [optional]
2020
**protocol** | **str** | The protocol used to connect to the discovery connection source. | [optional]
2121
**region** | **str** | The AWS region (only used for the AWS connection). | [optional]
2222
**scan_engine_is_inside_aws** | **bool** | Flag denoting whether the scan engine is in AWS, this is used for AWS discovery connections for scanning purposes (only used for the AWS connection). | [optional]

docs/ExploitSource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**key** | **str** | The identifier of the exploit in the source library. | [optional]
7-
**link** | [**ExploitSourceLink**](ExploitSourceLink.md) | ${exploit.source.link.description} | [optional]
7+
**link** | [**ExploitSourceLink**](ExploitSourceLink.md) | Link to the source of the exploit. | [optional]
88
**name** | **str** | The source library of the exploit, typically the name of the vendor that maintains and/or defined the exploit. | [optional]
99

1010
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/InstallSize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**backups** | [**BackupsSize**](BackupsSize.md) | The disk space used by backups. | [optional]
77
**database** | [**DatabaseSize**](DatabaseSize.md) | The disk space used by the database. | [optional]
8-
**directory** | [**File**](File.md) | The installation directory. | [optional]
8+
**directory** | **str** | The installation directory. | [optional]
99
**reports** | [**ReportSize**](ReportSize.md) | The disk space used by reports. | [optional]
1010
**scans** | [**ScanSize**](ScanSize.md) | The disk space used by scans. | [optional]
1111
**total** | [**InstallationTotalSize**](InstallationTotalSize.md) | Total disk space used by the installation. | [optional]

docs/PageOfAgent.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# PageOfAgent
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**links** | [**list[Link]**](Link.md) | Hypermedia links to corresponding or related resources. | [optional]
7+
**page** | [**PageInfo**](PageInfo.md) | The details of pagination indicating which page was returned, and how the remaining pages can be retrieved. | [optional]
8+
**resources** | [**list[Agent]**](Agent.md) | The page of resources returned. | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

docs/ReportApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ No authorization required
120120
121121
Report History
122122

123-
Returns the details for a generation of the report.
123+
Deletes an instance of a generated report.
124124

125125
### Example
126126
```python

docs/ReportConfigDatabaseCredentialsResource.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**password** | **str** | ${report.config.database.credential.password.description} | [optional]
7-
**username** | **str** | ${report.config.database.credential.username.description} | [optional]
6+
**password** | **str** | Database password. Only used when the format is `\"database-export\"`. | [optional]
7+
**username** | **str** | Database user name. Only used when the format is `\"database-export\"`. | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

docs/ReportConfigDatabaseResource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**credentials** | [**ReportConfigDatabaseCredentialsResource**](ReportConfigDatabaseCredentialsResource.md) | ${report.config.database.credentials.description} | [optional]
6+
**credentials** | [**ReportConfigDatabaseCredentialsResource**](ReportConfigDatabaseCredentialsResource.md) | Credential information for the target database. Only used when the format is `\"database-export\"`. | [optional]
77
**host** | **str** | The database server host to export to. | [optional]
88
**name** | **str** | The name of the database to export to. | [optional]
99
**port** | **int** | The database server port to export to. | [optional]

docs/ReportConfigScopeResource.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**asset_groups** | **list[int]** | ${report.config.asset.groups.description} | [optional]
7-
**assets** | **list[int]** | ${report.config.assets.description} | [optional]
8-
**scan** | **int** | ${report.config.scans.description} | [optional]
9-
**sites** | **list[int]** | ${report.config.sites.description} | [optional]
10-
**tags** | **list[int]** | ${report.config.tags.description} | [optional]
6+
**asset_groups** | **list[int]** | Identifiers of the asset groups in the scope of the report. | [optional]
7+
**assets** | **list[int]** | Identifiers of the assets in the scope of the report. | [optional]
8+
**scan** | **int** | Identifiers of the scans in the scope of the report. | [optional]
9+
**sites** | **list[int]** | Identifiers of the sites in the scope of the report. | [optional]
10+
**tags** | **list[int]** | Identifiers of the tags in the scope of the report. | [optional]
1111

1212
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1313

docs/ReportEmail.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
**access** | **str** | The format to distribute the report in when sending to users who have explicit access to the report. | [optional]
77
**additional** | **str** | The format to distribute the report to additional recipients. | [optional]
88
**additional_recipients** | **list[str]** | The email address of additional recipients to distribute the report to. | [optional]
9-
**asset_access** | **bool** | ${report.config.email.additional.asset.access.description} | [optional]
9+
**asset_access** | **bool** | Whether to distribute the report to all users to have access to assets in the report. | [optional]
1010
**owner** | **str** | The format to distribute the report to the owner. | [optional]
1111
**smtp** | [**ReportEmailSmtp**](ReportEmailSmtp.md) | SMTP delivery settings. | [optional]
1212

docs/RiskModifierSettings.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**high** | **float** | ${settings.risk.modifier.high} | [optional]
7-
**low** | **float** | ${settings.risk.modifier.low} | [optional]
8-
**medium** | **float** | ${settings.risk.modifier.medium} | [optional]
9-
**very_high** | **float** | ${settings.risk.modifier.veryHigh} | [optional]
10-
**very_low** | **float** | ${settings.risk.modifier.veryLow} | [optional]
6+
**high** | **float** | High critical adjustment modifier. | [optional]
7+
**low** | **float** | Low critical adjustment modifier. | [optional]
8+
**medium** | **float** | Medium critical adjustment modifier. | [optional]
9+
**very_high** | **float** | Very high critical adjustment modifier. | [optional]
10+
**very_low** | **float** | Very low critical adjustment modifier. | [optional]
1111

1212
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1313

0 commit comments

Comments
 (0)