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.

Scans request parameters

Prev Next

Retrieves the list of active scans.

Service

scans

Permission

Scans XML API

Version

4.4.9 or later

Parameter

Definition

HH$name

String

HH$tags

String

HH$Deleted

Boolean

HH$Valid

Boolean

HH$Enabled

Boolean

HH$Modified

Boolean

HH$Databases

Comma-separated list of database group names

HH$SysIdentifiers

Comma-separated list of test SYS identifiers

HH$pageSize

Long — The maximum number of results per call. The default value is -1 (ALL)

HH$pageNum

Long — The number of the page to return. The default value is 0

For example, to get the list of active scans, issue the request:

https://127.0.0.1:8443/xmlapi.svc?service=scans&HH$Valid=true