The new docs.trellix.com features a modernized UI and AI-powered conversational search. Content is currently available in English, with additional languages launching in early November 2026. We hope you enjoy the updated experience.

Add VA scan request parameters

Prev Next

Adds a VA scan.

Service

add-scan

Permission

Add Scan XML API

Version

4.4.9 or higher

Parameter

Definition

HH$Name

String

HH$Description

String

HH$Schedule

Schedule in cross tab format

HH$DatabasesAdd

Add comma-separated list of DB IDs

HH$DatabasesRemove

Remove comma-separated list of DB IDs

HH$GroupsAdd

Add comma-separated list of DB group names

HH$GroupsRemove

Remove comma-separated list of DB group names

HH$DatabaseExceptionsAdd

Add comma-separated list of DB IDs to exclude from the scan

HH$DatabaseExceptionsRemove

Remove comma-separated list of DB IDs to exclude from the scan

HH$TagsAdd

Add comma-separated list of categories (tags)

HH$TagsRemove

Remove comma-separated list of categories (tags)

HH$OmmittedRulesAdd

Add comma-separated list of rule IDs to exclude from the scan

HH$OmmittedRulesRemove

Remove comma-separated list of rule IDs to exclude from the scan

HH$actions

Comma-separated list of actions.

Available actions: LOG, EMAIL, SYSLOG, WINLOG, FILELOG, AUTO_RESOLVE

HH$winLevel

Winlog level

HH$fileLevel

File log level

HH$sysLevel

Syslog level

HH$resolve

Name of resolution (in case AUTO_RESOLVE action is set)

HH$email

Email address (in case EMAIL action was set)

HH$Severity

Comma-separated list of severities to check (HIGH, MEDIUM, LOW, NOTICE, andINFO)

HH$Enabled

Boolean

HH$StorePassword

Boolean — Store weak passwords

HH$RebuildPassword

Boolean — Rebuild the password cache

HH$OUs

List of comma-separated OUs

HH$Server

The server that this scan belongs to (relevant when the server is configured as a cluster)

For example, to add a new scan on database with ID#10007000 on category Audit, submit the request:

https://127.0.0.1:8443/xmlapi.svc?service=add-scan&HH$Name=newScan&HH$DatabasesAdd=10007000&HH$TagsAdd=Audit