Asset Search parameters

action=search

(Required)

output_format={csv|xml}

(Required) The output format of the asset search report. One output format may be specified: csv or xml.

tracking_method={value}

(Optional) Show only IP addresses/ranges which have a certain tracking method. Valid values: IP, DNS, NETBIOS, AZURE VM, EC2, AGENT

ips={value}

(Optional) Use this parameter if you want to include only certain IP addresses in the report. One or more IPs/ranges may be specified. Multiple entries are comma separated. An IP range is specified with a hyphen (for example, 10.10.10.1-10.10.10.100).

One of these parameters must be specified in a request: ips, asset_groups, asset_group_ids, or use_tags.

ips_network_id={value}

(Optional) The network ID applied on IPs. The default value is ALL.

asset_group_ids={value}

(Optional) The IDs of asset groups containing the hosts to be included in the asset search report. Multiple IDs are comma separated.

One of these parameters must be specified in a request: ips, asset_groups, asset_group_ids, or use_tags.

asset_groups={value}

(Optional) The titles of asset groups containing the hosts to be included in the asset search report. Multiple titles are comma separated.

One of these parameters must be specified in a request: ips, asset_groups, asset_group_ids, or use_tags.

assets_in_my_network_only={0|1}

(Optional) Specify 1 to include the specified asset groups and/or IP ranges. Valid for 'All' Asset Group and/or specified IP ranges.

ec2_instance_status={value}

(Optional) Specify the EC2 instance status to be searched. Possible values: RUNNING,TERMINATED, PENDING, STOPPING, SHUTTING_DOWN, STOPPED. Values are case-sensitive.

ec2_instance_status is valid only when tracking_method=EC2 or tracking_method=AGENT is specified.

ec2_instance_id={value}

(Optional) Specify the EC2 instance ID to be searched.

ec2_instance_id is valid only when ec2_instance_id_modifier is specified.

ec2_instance_id_modifier={value}

(Optional) Show only hosts with ec2_instance_id that is either: beginning with, containing, matching, ending with, not empty.

ec2_instance_id_modifier is valid only when ec2_instance_id is specified.

azure_vm_state={value}

(Optional) Specify the Azure virtual machine state to be searched. Possible values are: STARTING, RUNNING, STOPPING, STOPPED, DEALLOCATING, DEALLOCATED, UNKNOWN. Values are case-sensitive.

azure_vm_state is valid only when tracking_method=AZURE VM or tracking_method=AGENT is specified.

azure_vm_id={value}

(Optional) Specify the Azure virtual machine ID to be searched.

azure_vm_id is valid only when azure_vm_id_modifier is specified.

azure_vm_id_modifier=

{value}

(Optional) Show only assets with azure_vm_id that is either: beginning with, containing, matching, ending with, not empty.

azure_vm_id_modifier is valid only when azure_vm_id is specified.

display_ag_titles={0|1}

(Optional) Specify 1 to display Asset Group Titles for each Host in the output. Otherwise the Asset Group Titles are not displayed in the output.

ports={value}

(Optional) Shows the hosts that has the specified open ports. One or more ports may be specified. Multiple ports are comma separated. You can specify up to 10 values.

services={value}

(Optional) Shows the hosts that has the specified services running on it. One or more services may be specified. Multiple services are comma separated. You can specify up to 10 values.

qids={value}

(Optional) Shows vulnerabilities (QIDs) in the KnowledgeBase applicable to the host. Allows up to 20 values.

qid_with_text={value}

(Optional) Shows vulnerabilities (QIDs) with the specified text in the KnowledgeBase applicable to the host.

qid_with_text is valid only when qids parameter is specified.

qid_with_modifier={value}

(Optional) Show only hosts with QID that is either: beginning with, containing, matching, ending with.

qid_with_modifier is valid only when qid_with_text is specified.

use_tags={0|1}

(Optional) Specify 0 (the default) if you want to select hosts based on IP addresses/ranges and/or asset groups. Specify 1 if you want to select hosts based on asset tags.

One of these parameters must be specified in a request: ips, asset_groups, asset_group_ids, or use_tags.

tag_set_by={id|name}

(Optional when use_tags=1) Specify “id” (the default) to select a tag set by providing tag IDs. Specify “name” to select a tag set by providing tag names.

tag_include_selector={any|all}

(Optional when use_tags=1) Select “any” (the default) to include hosts that match at least one of the selected tags. Select “all” to include hosts that match all of the selected tags.

tag_exclude_selector={any|all}

(Optional when use_tags=1) Select “any” (the default) to exclude hosts that match at least one of the selected tags. Select “all” to exclude hosts that match all of the selected tags.

tag_set_include={value}

(Required when use_tags=1) Specify a tag set to include. Hosts that match these tags will be included. You identify the tag set by providing tag name or IDs. Multiple entries are comma separated.

tag_set_exclude={value}

(Optional when use_tags=1) Specify a tag set to exclude. Hosts that match these tags will be excluded. You identify the tag set by providing tag name or IDs. Multiple entries are comma separated.

first_found_days={value}

(Optional) Specify a number of days along with the first_found_modifier so that the range includes the first found date to be searched for

first_found_days is valid only when first_found_modifier is specified.

first_found_modifier={within|not within}

(Optional) Show only hosts whose first found date is within or not within the specified days.

first_found_modifier is valid only when first_found_days is specified.

last_vm_scan_days={value}

(Optional) Specify a number of days so that it includes the last vm scan date to be searched for.

last_vm_scan_days is valid only when last_vm_scan_modifier is specified.

last_vm_scan_modifier={within|not within}

(Optional) Show only hosts whose last_vm_scan_date is within or not within the specified days.

last_vm_scan_modifier is valid only when last_vm_scan_days is specified.

last_pc_scan_days={value}

(Optional) Specify a number of days so that the specified value along with the modifier forms the date range that includes the last scan date to be searched for.

This parameter is valid only when the policy compliance module is enabled for the user account.

last_pc_scan_modifier={within|not within}

(Optional) Show only hosts whose last_pc_scan_date is within or not within the specified days.

This parameter is valid only when the policy compliance module is enabled for the user account.

last_scap_scan_days={value}

(Optional) Specify a number of days so that the specified value along with the modifier forms the date range that includes the last SCAP scan date to be searched for.

This parameter is valid only when the policy compliance module is enabled for the user account.

last_scap_scan_modifier= {within|not within}

(Optional) Show only hosts whose last_scap_scan_date is within or not within the specified days.

This parameter is valid only when the policy compliance module is enabled for the user account.

dns_name={value}

(Optional) Specify the DNS name of the host that needs to be searched.

dns_name is valid only when dns_modifier is specified.

dns_modifier={value}

(Optional) Show only hosts with dns_name that is either: beginning with, containing, matching, ending with, not empty.

dns_modifier is valid only when dns_name is specified.

netbios_name={value}

(Optional) Specify the NETBIOS name of the host to be searched.

netbios_name is valid only when netbios_modifier is specified.

netbios_modifier={value}

(Optional) Show only hosts with netbios_name that is either: beginning with, containing, matching, ending with, not empty.

netbios_modifier is valid only when netbios_name is specified.

os_cpe_name={value}

(Optional) Specify the OS CPE name of the host to searched.

os_cpe_name is valid only when os_cpe_name is specified.

os_cpe_modifier={value}

(Optional)) Show only hosts with os cpe_name that is either: beginning with, containing, matching, ending with, not empty.

os_cpe_modifier is valid only when os_cpe_name is specified.

os_name={value}

(Optional) Specify the operating system name of the host to be searched.

os_name is valid only when os_modifier is specified.

os_modifier={value}

(Optional) Show only hosts with os_name that is either: beginning with, containing, matching, ending with.

os_modifier is valid only when os_name is specified.