Remove Excluded Hosts

GET POST/api/2.0/fo/asset/excluded_ip/?action=remove

GET POST/api/2.0/fo/asset/excluded_ip/?action=remove_all

Remove hosts from your excluded hosts list. You can choose to remove certain hosts (IPs) or all hosts from your excluded hosts list.

Permissions - Managers and Unit Managers have permission to remove IPs from the excluded host list.

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action={action}

Required String 

Specify remove - to remove certain IPs from excluded host list

remove_all - to remove all IPs from excluded host list

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}

Required when action=remove Integer 

The IP addresses to be removed from the excluded IPs list. Enter a comma separated list of IPv4 singletons or ranges. For example: 10.10.10.13,10.10.10.25-10.10.10.29

comment={value}

Required String 

User-defined notes (up to 1024 characters).

network_id={value}

Optional and valid only when the user making the request has access to more than one network Integer 

Identify a network ID that is assigned to the IPs being removed from the excluded IPs list. By default, the user’s default network ID is assigned.

Sample 1 - Remove Certain IPs from Exclude Host ListSample 1 - Remove Certain IPs from Exclude Host List

API Request

curl -H "X-Requested-With: curl" -u "USERNAME:PASSWD" -d"action=remove_all&comment=remove all ips""https://<qualys_base_url>/api/2.0/fo/asset/excluded_ip/"

XML Output

<!DOCTYPE SIMPLE_RETURN SYSTEM "https://<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2018-04-15T04:05:04Z</DATETIME>
    <TEXT>Removed IPs from Excluded IPs list.</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>Removed IPs</KEY>
        <VALUE>10.10.34.250-10.10.34.254</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

Sample 2 - Remove All IPs from Excluded Host ListSample 2 - Remove All IPs from Excluded Host List

API Request

curl -H "X-Requested-With: curl" -u "USERNAME:PASSWD" -d"action=remove_all&comment=remove all ips""https://<qualys_base_url>/api/2.0/fo/asset/excluded_ip/"

XML Output

<!DOCTYPE SIMPLE_RETURN SYSTEM "https://<qualys_base_url>/api/2.0/simple_return.dtd">
<SIMPLE_RETURN>
  <RESPONSE>
    <DATETIME>2018-04-24T00:08:19Z</DATETIME>
    <TEXT>Removed IPs from Excluded IPs list.</TEXT>
    <ITEM_LIST>
      <ITEM>
        <KEY>Removed IPs</KEY>
        <VALUE>10.100.100.101-10.100.100.255,100.100.100.101-100.100.100.255</VALUE>
      </ITEM>
    </ITEM_LIST>
  </RESPONSE>
</SIMPLE_RETURN>

DTD

DTD returned by requests to add and remove excluded hosts.

<platform API server>/api/2.0/simple_return.dtd