Show the excluded host list for the user's account. Hosts in your excluded host list will not be scanned.
Permissions - Managers, Auditors view all excluded hosts in subscription. Unit Managers view excluded hosts in their own business unit. Scanners, Readers view excluded hosts in their account.
Express Lite - This API is available to Express Lite users.
|
Parameter |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
|
action=list |
Required | String |
Specify action=list to list excluded hosts. |
|
echo_request={0|1} |
Optional | Integer |
Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
|
ips={value} |
Optional | Integer |
Show only certain excluded IP addresses/ranges. When unspecified, all excluded IPs/ranges in your account will be listed. 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.24.1-10.10.24.20). |
|
network_id={value} |
Optional and valid only when the Network Support feature is enabled for the user’s account | String |
Restrict the request to a certain custom network ID. You might need to use this parameter to get the excluded host list you're interested in. Learn more |
|
Asset Groups |
|
||
|
ag_ids={value} |
Optional | Integer |
Show excluded hosts belonging to asset groups with certain IDs. One or more asset group IDs and/or ranges may be specified. Multiple entries are comma separated. A range is specified with a dash (for example, 386941-386945). Valid asset group IDs are required. These parameters are mutually exclusive and cannot be specified together: ag_ids and ag_titles. |
|
ag_titles={value} |
Optional | String |
Show excluded hosts belonging to asset groups with certain strings in the asset group title. One or more asset group titles may be specified. Multiple entries are comma separated (for example, My+First+Asset+Group,Another+Asset+Group). These parameters are mutually exclusive and cannot be specified together: ag_ids and ag_titles. |
|
Asset Tags |
|
||
|
use_tags={0|1} |
Optional | Integer |
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. |
|
tag_include_selector={any|all} |
Optional when use_tags=1) Specify "any" (the default | Boolean |
Specify to include excluded hosts that match at least one of the selected tags. Specify "all" to include excluded hosts that match all of the selected tags. |
|
tag_exclude_selector={any|all} |
Optional when use_tags=1) Specify "any" (the default | Boolean |
Specify to ignore excluded hosts that match at least one of the selected tags. Specify "all" to ignore excluded hosts that match all of the selected tags. |
|
tag_set_by={id|name} |
Optional when use_tags=1) Specify "id" (the default | String/ Integer |
Specify to select a tag set by providing tag IDs. Specify "name" to select a tag set by providing tag names. |
|
tag_set_include={value} |
Optional when use_tags=1 | String/ Integer |
Specify a tag set to include. Excluded 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 | String/ Integer |
Specify a tag set to exclude. Excluded hosts that match these tags will be ignored. You identify the tag set by providing tag name or IDs. Multiple entries are comma separated. |
API Request
curl -u USERNAME:PASSWORD -H "X-Requested-With: curl demo 2"-D headers.15 "https://<qualys_base_url>/api/2.0/fo/asset/excluded_ip/?action=list"XML Output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE IP_LIST_OUTPUT SYSTEM
"https://<qualys_base_url>/api/2.0/fo/asset/excluded_ip/ip_list_output.dtd">
<IP_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2018-01-23T00:33:24Z</DATETIME>
<IP_SET>
<IP_RANGE network_id="0" expiration_date="2015-04-28T00:00:00Z">10.100.100.101-10.100.100.255</IP_RANGE>
<IP network_id="14665885">10.10.10.1</IP>
<IP network_id="0">10.100.100.100</IP>
<IP network_id="0">100.100.100.100</IP>
</IP_SET>
</RESPONSE>
</IP_LIST_OUTPUT>API Request
curl -u USERNAME:PASSWORD -H "X-Requested-With: curl demo 2"-D headers.16 "https://<qualys_base_url>/api/2.0/fo/asset/excluded_ip/?action=list&ips=10.10.24.1-10.10.24.255"<platform API server>/api/2.0/fo/asset/excluded_ip/ip_list_output.dtd