Was this topic helpful?
List the containerized scanner appliance in your account.
|
Parameter |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
|
action=list |
Required |
String |
Specify action to list containerized scanner appliances. |
|
echo_request={0|1} |
Optional |
Integer |
Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
|
output_mode={brief|full} |
Optional |
Boolean |
The amount of detail provided for each scanner appliance in the output: brief (default) or full. The "brief" output includes this information for each appliance: appliance ID, friendly name, software version, the number of running scans, and heartbeat check status (online or offline). The "full" output includes the full appliance information, including the same details available in the Qualys user interface. |
|
scan_detail={0|1} |
Optional |
Integer |
Set to 1 to include scan details for scans currently running on the scanner appliance. Set to 0 (default) to not include scan details. Scan detail includes scan ID, title, scan reference, scan type and scan date. |
|
include_cloud_info={0|1} |
Optional |
Integer |
When specified output_mode=full is required) Set to 1 to include cloud information in the output for containerized scanner appliances deployed on cloud platforms e.g. Amazon EC2, Microsoft Azure Cloud Platform and Google Cloud Platform. Set to 0 (default) to not include cloud info. |
|
busy={0|1} |
Optional |
Integer |
By default all scanner appliances in the user account are shown. Set to 0 to show only appliances which are not currently running scans. Set to 1 (default) to show only appliances which are currently running scans. |
|
scan_ref={value} |
Optional |
String |
Specify a scan reference code to show only the scanner appliances running a particular scan. You may enter a valid scan reference code for a currently running scan. The scan reference code starts with a string that identifies the scan type: "scan/" for a vulnerability scan, "compliance/" for a compliance scan, "was/" for a web application scan, "qscap/" for an FDCC scan, or "map/" for a network map. |
|
name={string} |
Optional |
String |
List only scanner appliances that have names matching the string provided. Tip - Substring match is supported. For example, if you have 2 appliances named "myscanner" and "anotherscanner" and you supply the string "name=scan" both appliance both appliances will be returned in the XML output. |
|
ids={id1,id2,...} |
Optional |
Integer |
List only scanner appliances that have certain IDs. Multiple IDs are comma separated. |
|
include_license_info={0|1} |
Optional |
Set to 1 to return containerized scanner license information in the XML output. This tells you the number of licenses you have and the number used. This information is not returned by default. When specified the XML output will include the LICENSE_INFO element. |
|
|
type={physical | virtual | containerized | offline} |
Optional |
Boolean |
Type of scanner appliances: physical, virtual, containerized, or offline. Type appears when output_mode=full is specified in API request. |
|
platform_provider |
Optional |
String |
Specify a platform to show scanners deployed on that platform. The valid values are: ec2, ec2_compat, gce, azure, vCenter. ec2 - Amazon EC2, ec2_compat - OpenStack, gce - Google Cloud Platform, azure - Microsoft Azure Cloud Platform, vCenter - VMware vCenter |
API Request
curl --location --request POST
'https://<qualys_base_url>/api/2.0/fo/appliance/qcss/?action=list&
output_mode=full' \
--header 'X-Requested-With: abc' \
--header 'Authorization: Basic cXdlYl9ybTI6UWF0ZW1wMTIzIw=='XML Output
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE APPLIANCE_LIST_OUTPUT SYSTEM "https:// <qualys_base_url>/api/2.0/fo/appliance/appliance_list_output.dtd "> <APPLIANCE_LIST_OUTPUT> <RESPONSE> <DATETIME>2024-03-28T04:56:15Z</DATETIME> <APPLIANCE_LIST> <APPLIANCE> <ID>1227190</ID> <UUID>2c951232-e993-f1a3-8064-888ae369b2bf</UUID> <NAME>QcssScannerApi2</NAME> <NETWORK_ID>0</NETWORK_ID> <SOFTWARE_VERSION>0</SOFTWARE_VERSION> <RUNNING_SLICES_COUNT>0</RUNNING_SLICES_COUNT> <RUNNING_SCAN_COUNT>0</RUNNING_SCAN_COUNT> <STATUS>Offline</STATUS> <MODEL_NUMBER>qcss</MODEL_NUMBER> <TYPE>Containerized</TYPE> <SERIAL_NUMBER>0</SERIAL_NUMBER> <ACTIVATION_CODE>70105819066298</ACTIVATION_CODE> <INTERFACE_SETTINGS> <INTERFACE>lan</INTERFACE> <IP_ADDRESS></IP_ADDRESS> <NETMASK>128.0.0.0</NETMASK> <GATEWAY>128.0.0.0</GATEWAY> <LEASE>Static</LEASE> <IPV6_ADDRESS></IPV6_ADDRESS> <SPEED></SPEED> <DUPLEX>Unknown</DUPLEX> <DNS> <DOMAIN></DOMAIN> <PRIMARY>128.0.0.0</PRIMARY> <SECONDARY>128.0.0.0</SECONDARY> </DNS> </INTERFACE_SETTINGS> <INTERFACE_SETTINGS> <SETTING>Disabled</SETTING> <INTERFACE>wan</INTERFACE> <IP_ADDRESS></IP_ADDRESS> <NETMASK>128.0.0.0</NETMASK> <GATEWAY>128.0.0.0</GATEWAY> <LEASE>Static</LEASE> <SPEED></SPEED> <DUPLEX>Unknown</DUPLEX> <DNS> <PRIMARY>128.0.0.0</PRIMARY> <SECONDARY>128.0.0.0</SECONDARY> </DNS> </INTERFACE_SETTINGS> <PROXY_SETTINGS> <SETTING>Disabled</SETTING> <PROXY> <IP_ADDRESS>128.0.0.0</IP_ADDRESS> <PORT></PORT> <USER></USER> </PROXY> </PROXY_SETTINGS> <VLANS> <SETTING>Disabled</SETTING> </VLANS> <STATIC_ROUTES /> <ML_LATEST>12.11.28-1</ML_LATEST> <ML_VERSION updated="no"></ML_VERSION> <VULNSIGS_LATEST>2.5.993-3</VULNSIGS_LATEST> <VULNSIGS_VERSION updated="no"></VULNSIGS_VERSION> <ASSET_GROUP_COUNT>0</ASSET_GROUP_COUNT> <ASSET_GROUP_LIST /> <LAST_UPDATED_DATE>N/A</LAST_UPDATED_DATE> <POLLING_INTERVAL>180 seconds</POLLING_INTERVAL> <USER_LOGIN>qweb_rm2</USER_LOGIN> <HEARTBEATS_MISSED>0</HEARTBEATS_MISSED> <SS_CONNECTION>Inactive</SS_CONNECTION> <SS_LAST_CONNECTED>2023-03-29T04:54:37Z</SS_LAST_CONNECTED> <USER_LIST /> <UPDATED>No</UPDATED> <COMMENTS> <![CDATA[]]> </COMMENTS> <MAX_CAPACITY_UNITS></MAX_CAPACITY_UNITS> <CPU_INFO></CPU_INFO> <MEMORY_INFO></MEMORY_INFO> <REGION_INFO></REGION_INFO> </APPLIANCE> </APPLIANCE_LIST> </RESPONSE> </APPLIANCE_LIST_OUTPUT>
<platform API server>/api/2.0/fo/appliance/qcss/?action=list_output.dtd
Was this topic helpful?