Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

Server path: /rapid7-appsec | Type: Application | PCID required: Yes

Tools

ToolDescription
rapid7_appsec_add_app_tagAdd App Tag
rapid7_appsec_add_app_userAdd App User
rapid7_appsec_create_appCreate App
rapid7_appsec_create_attack_moduleCreate Attack Module
rapid7_appsec_create_attack_templateCreate Attack Template
rapid7_appsec_create_blackoutCreate Blackout
rapid7_appsec_create_engineCreate Engine
rapid7_appsec_create_engine_groupCreate Engine Group
rapid7_appsec_create_fileCreate File
rapid7_appsec_create_scan_configCreate Scan Config
rapid7_appsec_create_scheduleCreate Schedule
rapid7_appsec_create_tagCreate Tag
rapid7_appsec_create_targetCreate Target
rapid7_appsec_create_vulnerability_commentCreate Vulnerability Comment
rapid7_appsec_delete_appDelete App
rapid7_appsec_delete_attack_moduleDelete Attack Module
rapid7_appsec_delete_attack_templateDelete Attack Template
rapid7_appsec_delete_blackoutDelete Blackout
rapid7_appsec_delete_engineDelete Engine
rapid7_appsec_delete_engine_credentialDelete Engine Credential
rapid7_appsec_delete_engine_groupDelete Engine Group
rapid7_appsec_delete_fileDelete File
rapid7_appsec_delete_reportDelete Report
rapid7_appsec_delete_scanDelete Scan
rapid7_appsec_delete_scan_configDelete Scan Config
rapid7_appsec_delete_scheduleDelete Schedule
rapid7_appsec_delete_tagDelete Tag
rapid7_appsec_delete_targetDelete Target
rapid7_appsec_delete_vulnerability_commentDelete Vulnerability Comment
rapid7_appsec_generate_reportGenerate Report
rapid7_appsec_get_appGet App
rapid7_appsec_get_app_tagsGet App Tags
rapid7_appsec_get_app_usersGet App Users
rapid7_appsec_get_appsGet Apps
rapid7_appsec_get_attackGet Attack
rapid7_appsec_get_attack_documentationGet Attack Documentation
rapid7_appsec_get_attack_modulesGet Attack Modules
rapid7_appsec_get_attack_modules_configsGet Attack Modules Configs
rapid7_appsec_get_attack_templateGet Attack Template
rapid7_appsec_get_attack_templatesGet Attack Templates
rapid7_appsec_get_blackoutGet Blackout
rapid7_appsec_get_blackoutsGet Blackouts
rapid7_appsec_get_documentation_by_varianceGet Vulnerability Variance Documentation
rapid7_appsec_get_documentation_by_variancesGet Vulnerability Variances Documentation
rapid7_appsec_get_engineGet Engine
rapid7_appsec_get_engine_credentialGet Engine Credential
rapid7_appsec_get_engine_groupGet Engine Group
rapid7_appsec_get_engine_group_enginesGet Engine Group Engines
rapid7_appsec_get_engine_groupsGet Engine Groups
rapid7_appsec_get_enginesGet Engines
rapid7_appsec_get_fileGet File
rapid7_appsec_get_filesGet Files
rapid7_appsec_get_moduleGet Module
rapid7_appsec_get_modulesGet Modules
rapid7_appsec_get_reportGet Report
rapid7_appsec_get_reportsGet Reports
rapid7_appsec_get_scanGet Scan
rapid7_appsec_get_scan_actionGet Scan Action
rapid7_appsec_get_scan_configGet Scan Config
rapid7_appsec_get_scan_config_optionsGet Scan Config Options
rapid7_appsec_get_scan_configsGet Scan Configs
rapid7_appsec_get_scan_configs_options_defaultGet Scan Configs Options Default
rapid7_appsec_get_scan_engine_eventsGet Scan Engine Events
rapid7_appsec_get_scan_execution_detailsGet Scan Execution Details
rapid7_appsec_get_scan_platform_eventsGet Scan Platform Events
rapid7_appsec_get_scansGet Scans
rapid7_appsec_get_scheduleGet Schedule
rapid7_appsec_get_schedulesGet Schedules
rapid7_appsec_get_tagGet Tag
rapid7_appsec_get_tagsGet Tags
rapid7_appsec_get_targetGet Target
rapid7_appsec_get_targetsGet Targets
rapid7_appsec_get_vulnerabilitiesGet Vulnerabilities
rapid7_appsec_get_vulnerabilityGet Vulnerability
rapid7_appsec_get_vulnerability_commentGet Vulnerability Comment
rapid7_appsec_get_vulnerability_commentsGet Vulnerability Comments
rapid7_appsec_get_vulnerability_discoveriesGet Vulnerability Discoveries
rapid7_appsec_get_vulnerability_discoveryGet Vulnerability Discovery
rapid7_appsec_get_vulnerability_historyGet Vulnerability History
rapid7_appsec_patch_scan_config_optionsPatch Scan Config Options
rapid7_appsec_perform_searchPerform Search
rapid7_appsec_regenerate_engine_credentialRegenerate Engine Credential
rapid7_appsec_remove_app_tagRemove App Tag
rapid7_appsec_remove_app_userRemove App User
rapid7_appsec_submit_scanSubmit Scan
rapid7_appsec_submit_scan_actionSubmit Scan Action
rapid7_appsec_update_appUpdate App
rapid7_appsec_update_attack_moduleUpdate Attack Module
rapid7_appsec_update_attack_templateUpdate Attack Template
rapid7_appsec_update_blackoutUpdate Blackout
rapid7_appsec_update_engineUpdate Engine
rapid7_appsec_update_engine_groupUpdate Engine Group
rapid7_appsec_update_fileUpdate File
rapid7_appsec_update_scan_configUpdate Scan Config
rapid7_appsec_update_scan_config_optionsUpdate Scan Config Options
rapid7_appsec_update_scheduleUpdate Schedule
rapid7_appsec_update_tagUpdate Tag
rapid7_appsec_update_targetUpdate Target
rapid7_appsec_update_vulnerabilityUpdate Vulnerability
rapid7_appsec_update_vulnerability_commentUpdate Vulnerability Comment
rapid7_appsec_upgrade_engineUpgrade Engine
rapid7_appsec_upload_fileUpload File Content

rapid7_appsec_add_app_tag

Add App Tag Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value
bodyobjectYesThe last editor of the comment

rapid7_appsec_add_app_user

Add App User Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value
bodyobjectYesThe Scan Config of the Schedule

rapid7_appsec_create_app

Create App Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

rapid7_appsec_create_attack_module

Create Attack Module Parameters:
ParameterTypeRequiredDefaultDescription
attack-template-idstringYesThe attack-template-id value
bodyobjectYesRequest body

rapid7_appsec_create_attack_template

Create Attack Template Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

rapid7_appsec_create_blackout

Create Blackout Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

rapid7_appsec_create_engine

Create Engine Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

rapid7_appsec_create_engine_group

Create Engine Group Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

rapid7_appsec_create_file

Create File Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value
bodyobjectYesRequest body

rapid7_appsec_create_scan_config

Create Scan Config Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

rapid7_appsec_create_schedule

Create Schedule Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

rapid7_appsec_create_tag

Create Tag Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

rapid7_appsec_create_target

Create Target Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

rapid7_appsec_create_vulnerability_comment

Create Vulnerability Comment Parameters:
ParameterTypeRequiredDefaultDescription
vuln-idstringYesThe vuln-id value
bodyobjectYesRequest body

rapid7_appsec_delete_app

Delete App Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value

rapid7_appsec_delete_attack_module

Delete Attack Module Parameters:
ParameterTypeRequiredDefaultDescription
attack-template-idstringYesThe attack-template-id value
attack-module-idstringYesThe attack-module-id value

rapid7_appsec_delete_attack_template

Delete Attack Template Parameters:
ParameterTypeRequiredDefaultDescription
attack-template-idstringYesThe attack-template-id value

rapid7_appsec_delete_blackout

Delete Blackout Parameters:
ParameterTypeRequiredDefaultDescription
blackout-idstringYesThe blackout-id value

rapid7_appsec_delete_engine

Delete Engine Parameters:
ParameterTypeRequiredDefaultDescription
engine-idstringYesThe engine-id value

rapid7_appsec_delete_engine_credential

Delete Engine Credential Parameters:
ParameterTypeRequiredDefaultDescription
engine-idstringYesThe engine-id value

rapid7_appsec_delete_engine_group

Delete Engine Group Parameters:
ParameterTypeRequiredDefaultDescription
engine-group-idstringYesThe engine-group-id value

rapid7_appsec_delete_file

Delete File Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value
file-idstringYesThe file-id value

rapid7_appsec_delete_report

Delete Report Parameters:
ParameterTypeRequiredDefaultDescription
report-idstringYesThe report-id value

rapid7_appsec_delete_scan

Delete Scan Parameters:
ParameterTypeRequiredDefaultDescription
scan-idstringYesThe scan-id value

rapid7_appsec_delete_scan_config

Delete Scan Config Parameters:
ParameterTypeRequiredDefaultDescription
scan-config-idstringYesThe scan-config-id value

rapid7_appsec_delete_schedule

Delete Schedule Parameters:
ParameterTypeRequiredDefaultDescription
schedule-idstringYesThe schedule-id value

rapid7_appsec_delete_tag

Delete Tag Parameters:
ParameterTypeRequiredDefaultDescription
tag-idstringYesThe tag-id value
cascadebooleanNoThe cascade value

rapid7_appsec_delete_target

Delete Target Parameters:
ParameterTypeRequiredDefaultDescription
target-idstringYesThe target-id value

rapid7_appsec_delete_vulnerability_comment

Delete Vulnerability Comment Parameters:
ParameterTypeRequiredDefaultDescription
vuln-idstringYesThe vuln-id value
comment-idstringYesThe comment-id value

rapid7_appsec_generate_report

Generate Report Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

rapid7_appsec_get_app

Get App Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value

rapid7_appsec_get_app_tags

Get App Tags Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value

rapid7_appsec_get_app_users

Get App Users Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value

rapid7_appsec_get_apps

Get Apps Parameters:
ParameterTypeRequiredDefaultDescription
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_attack

Get Attack Parameters:
ParameterTypeRequiredDefaultDescription
module-idstringYesThe module-id value
attack-idstringYesThe attack-id value

rapid7_appsec_get_attack_documentation

Get Attack Documentation Parameters:
ParameterTypeRequiredDefaultDescription
module-idstringYesThe module-id value
attack-idstringYesThe attack-id value

rapid7_appsec_get_attack_modules

Get Attack Modules Parameters:
ParameterTypeRequiredDefaultDescription
attack-template-idstringYesThe attack-template-id value

rapid7_appsec_get_attack_modules_configs

Get Attack Modules Configs

rapid7_appsec_get_attack_template

Get Attack Template Parameters:
ParameterTypeRequiredDefaultDescription
attack-template-idstringYesThe attack-template-id value

rapid7_appsec_get_attack_templates

Get Attack Templates Parameters:
ParameterTypeRequiredDefaultDescription
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_blackout

Get Blackout Parameters:
ParameterTypeRequiredDefaultDescription
blackout-idstringYesThe blackout-id value

rapid7_appsec_get_blackouts

Get Blackouts Parameters:
ParameterTypeRequiredDefaultDescription
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_documentation_by_variance

Get Vulnerability Variance Documentation Parameters:
ParameterTypeRequiredDefaultDescription
vuln-idstringYesThe vuln-id value
variance-idstringYesThe variance-id value

rapid7_appsec_get_documentation_by_variances

Get Vulnerability Variances Documentation Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

rapid7_appsec_get_engine

Get Engine Parameters:
ParameterTypeRequiredDefaultDescription
engine-idstringYesThe engine-id value

rapid7_appsec_get_engine_credential

Get Engine Credential Parameters:
ParameterTypeRequiredDefaultDescription
engine-idstringYesThe engine-id value

rapid7_appsec_get_engine_group

Get Engine Group Parameters:
ParameterTypeRequiredDefaultDescription
engine-group-idstringYesThe engine-group-id value

rapid7_appsec_get_engine_group_engines

Get Engine Group Engines Parameters:
ParameterTypeRequiredDefaultDescription
engine-group-idstringYesThe engine-group-id value
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_engine_groups

Get Engine Groups Parameters:
ParameterTypeRequiredDefaultDescription
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_engines

Get Engines Parameters:
ParameterTypeRequiredDefaultDescription
pageConfigobjectYesPage Config

rapid7_appsec_get_file

Get File Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value
file-idstringYesThe file-id value

rapid7_appsec_get_files

Get Files Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_module

Get Module Parameters:
ParameterTypeRequiredDefaultDescription
module-idstringYesThe module-id value

rapid7_appsec_get_modules

Get Modules

rapid7_appsec_get_report

Get Report Parameters:
ParameterTypeRequiredDefaultDescription
report-idstringYesThe report-id value

rapid7_appsec_get_reports

Get Reports Parameters:
ParameterTypeRequiredDefaultDescription
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_scan

Get Scan Parameters:
ParameterTypeRequiredDefaultDescription
scan-idstringYesThe scan-id value

rapid7_appsec_get_scan_action

Get Scan Action Parameters:
ParameterTypeRequiredDefaultDescription
scan-idstringYesThe scan-id value

rapid7_appsec_get_scan_config

Get Scan Config Parameters:
ParameterTypeRequiredDefaultDescription
scan-config-idstringYesThe scan-config-id value

rapid7_appsec_get_scan_config_options

Get Scan Config Options Parameters:
ParameterTypeRequiredDefaultDescription
scan-config-idstringYesThe scan-config-id value

rapid7_appsec_get_scan_configs

Get Scan Configs Parameters:
ParameterTypeRequiredDefaultDescription
include-errorsbooleanNoThe include-errors value
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_scan_configs_options_default

Get Scan Configs Options Default

rapid7_appsec_get_scan_engine_events

Get Scan Engine Events Parameters:
ParameterTypeRequiredDefaultDescription
scan-idstringYesThe scan-id value

rapid7_appsec_get_scan_execution_details

Get Scan Execution Details Parameters:
ParameterTypeRequiredDefaultDescription
scan-idstringYesThe scan-id value

rapid7_appsec_get_scan_platform_events

Get Scan Platform Events Parameters:
ParameterTypeRequiredDefaultDescription
scan-idstringYesThe scan-id value

rapid7_appsec_get_scans

Get Scans Parameters:
ParameterTypeRequiredDefaultDescription
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_schedule

Get Schedule Parameters:
ParameterTypeRequiredDefaultDescription
schedule-idstringYesThe schedule-id value

rapid7_appsec_get_schedules

Get Schedules Parameters:
ParameterTypeRequiredDefaultDescription
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_tag

Get Tag Parameters:
ParameterTypeRequiredDefaultDescription
tag-idstringYesThe tag-id value

rapid7_appsec_get_tags

Get Tags Parameters:
ParameterTypeRequiredDefaultDescription
rootbooleanNoThe root value
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_target

Get Target Parameters:
ParameterTypeRequiredDefaultDescription
target-idstringYesThe target-id value

rapid7_appsec_get_targets

Get Targets Parameters:
ParameterTypeRequiredDefaultDescription
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_vulnerabilities

Get Vulnerabilities Parameters:
ParameterTypeRequiredDefaultDescription
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_vulnerability

Get Vulnerability Parameters:
ParameterTypeRequiredDefaultDescription
vuln-idstringYesThe vuln-id value

rapid7_appsec_get_vulnerability_comment

Get Vulnerability Comment Parameters:
ParameterTypeRequiredDefaultDescription
vuln-idstringYesThe vuln-id value
comment-idstringYesThe comment-id value

rapid7_appsec_get_vulnerability_comments

Get Vulnerability Comments Parameters:
ParameterTypeRequiredDefaultDescription
vuln-idstringYesThe vuln-id value

rapid7_appsec_get_vulnerability_discoveries

Get Vulnerability Discoveries Parameters:
ParameterTypeRequiredDefaultDescription
vuln-idstringYesThe vuln-id value
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value

rapid7_appsec_get_vulnerability_discovery

Get Vulnerability Discovery Parameters:
ParameterTypeRequiredDefaultDescription
vuln-idstringYesThe vuln-id value
vuln-discovery-idstringYesThe vuln-discovery-id value

rapid7_appsec_get_vulnerability_history

Get Vulnerability History Parameters:
ParameterTypeRequiredDefaultDescription
vuln-idstringYesThe vuln-id value

rapid7_appsec_patch_scan_config_options

Patch Scan Config Options Parameters:
ParameterTypeRequiredDefaultDescription
scan-config-idstringYesThe scan-config-id value
bodyobjectYesRequest body

Perform Search Parameters:
ParameterTypeRequiredDefaultDescription
limitDatabooleanNoLimit Data
indexintegerNoThe index value
sizeintegerNoThe size value
sortstringNoSort order for results
page-tokenstringNoThe page-token value
bodyobjectYesRequest body

rapid7_appsec_regenerate_engine_credential

Regenerate Engine Credential Parameters:
ParameterTypeRequiredDefaultDescription
engine-idstringYesThe engine-id value

rapid7_appsec_remove_app_tag

Remove App Tag Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value
tag-idstringYesThe tag-id value

rapid7_appsec_remove_app_user

Remove App User Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value
user-idstringYesThe user-id value

rapid7_appsec_submit_scan

Submit Scan Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesRequest body

rapid7_appsec_submit_scan_action

Submit Scan Action Parameters:
ParameterTypeRequiredDefaultDescription
scan-idstringYesThe scan-id value
bodyobjectYesRequest body

rapid7_appsec_update_app

Update App Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value
bodyobjectYesRequest body

rapid7_appsec_update_attack_module

Update Attack Module Parameters:
ParameterTypeRequiredDefaultDescription
attack-template-idstringYesThe attack-template-id value
attack-module-idstringYesThe attack-module-id value
bodyobjectYesRequest body

rapid7_appsec_update_attack_template

Update Attack Template Parameters:
ParameterTypeRequiredDefaultDescription
attack-template-idstringYesThe attack-template-id value
bodyobjectYesRequest body

rapid7_appsec_update_blackout

Update Blackout Parameters:
ParameterTypeRequiredDefaultDescription
blackout-idstringYesThe blackout-id value
bodyobjectYesRequest body

rapid7_appsec_update_engine

Update Engine Parameters:
ParameterTypeRequiredDefaultDescription
engine-idstringYesThe engine-id value
bodyobjectYesRequest body

rapid7_appsec_update_engine_group

Update Engine Group Parameters:
ParameterTypeRequiredDefaultDescription
engine-group-idstringYesThe engine-group-id value
bodyobjectYesRequest body

rapid7_appsec_update_file

Update File Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value
file-idstringYesThe file-id value
bodyobjectYesRequest body

rapid7_appsec_update_scan_config

Update Scan Config Parameters:
ParameterTypeRequiredDefaultDescription
scan-config-idstringYesThe scan-config-id value
bodyobjectYesRequest body

rapid7_appsec_update_scan_config_options

Update Scan Config Options Parameters:
ParameterTypeRequiredDefaultDescription
scan-config-idstringYesThe scan-config-id value
bodyobjectYesRequest body

rapid7_appsec_update_schedule

Update Schedule Parameters:
ParameterTypeRequiredDefaultDescription
schedule-idstringYesThe schedule-id value
bodyobjectYesRequest body

rapid7_appsec_update_tag

Update Tag Parameters:
ParameterTypeRequiredDefaultDescription
tag-idstringYesThe tag-id value
bodyobjectYesRequest body

rapid7_appsec_update_target

Update Target Parameters:
ParameterTypeRequiredDefaultDescription
target-idstringYesThe target-id value
bodyobjectYesRequest body

rapid7_appsec_update_vulnerability

Update Vulnerability Parameters:
ParameterTypeRequiredDefaultDescription
vuln-idstringYesThe vuln-id value
bodyobjectYesRequest body

rapid7_appsec_update_vulnerability_comment

Update Vulnerability Comment Parameters:
ParameterTypeRequiredDefaultDescription
vuln-idstringYesThe vuln-id value
comment-idstringYesThe comment-id value
bodyobjectYesRequest body

rapid7_appsec_upgrade_engine

Upgrade Engine Parameters:
ParameterTypeRequiredDefaultDescription
engine-idstringYesThe engine-id value

rapid7_appsec_upload_file

Upload File Content Parameters:
ParameterTypeRequiredDefaultDescription
app-idstringYesThe app-id value
file-idstringYesThe file-id value