Excluded Hosts Change History
Click here to see this page in full context

Excluded Hosts Change History

GET POSTapi/2.0/fo/asset/excluded_ip/history/?action=list

View change history for excluded hosts in the user’s subscription. History record IDs in the XML output are listed in decreasing order.

Permissions - Users with these roles have permission to view all excluded hosts in the subscription: Manager, Auditor, Unit Manager, Scanner and Reader.

Unlike other APIs, an excluded hosts change history request returns change history records for all relevant IP addresses in the subscription, regardless of whether the user has access to these IP addresses in their account.

Input ParametersInput Parameters

Parameter

Required/Optional

Data Type

Description

action=list

 Required String 

Specify action=list to view excluded hosts change history

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 subscription 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 Integer 

Specify a network ID to restrict the request to a certain custom network.

id_min={value}

 Optional Integer 

Show only those history records in your subscription that have an ID number greater than or equal to an ID number you specify.

id_max={value}

 Optional Integer 

Show only those history records in your subscription that have an ID number less than or equal to an ID number you specify.

ids={value}

 Optional Integer 

Show only those history records in your subscription that have ID numbers matching the ID numbers you specify.

Sample - Change List for All Excluded IPsSample - Change List for All Excluded IPs

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/history/?action=list"

XML Output

<!DOCTYPE HISTORY_LIST_OUTPUT SYSTEM "https://<qualys_base_url>/api/2.0/fo/asset/excluded_ip/history/history_list_output.dtd">
<HISTORY_LIST_OUTPUT>
  <RESPONSE>
    <DATETIME>2018-01-18T01:48:42Z</DATETIME>
    <HISTORY_LIST>
      <HISTORY>
        <ID>1923</ID>
        <IP_SET>
          <IP_RANGE>10.10.10.2-10.10.10.11</IP_RANGE>
          <IP_RANGE>10.10.10.32-10.10.10.34</IP_RANGE>
          <IP>10.10.30.70</IP>
        </IP_SET>
        <ACTION>Added</ACTION>
        <DATETIME>2017-12-02T05:19:06Z</DATETIME>
        <USER_LOGIN>quays_ab</USER_LOGIN>
        <COMMENTS><![CDATA[my comments]]></COMMENTS>
      </HISTORY>
      <HISTORY>
        <ID>1863</ID>
        <IP_SET>
          <IP_RANGE>10.10.10.102-10.10.10.120</IP_RANGE>
        </IP_SET>
        <ACTION>Removed</ACTION>
        <DATETIME>2017-06-01T23:51:26Z</DATETIME>
        <USER_LOGIN>quays_ab</USER_LOGIN>
        <COMMENTS><![CDATA[Removing 10.10.10.102-10.10.10.120]]></COMMENTS>
      </HISTORY>
      <HISTORY>
        <ID>1663</ID>
        <IP_SET>
          <IP_RANGE>10.10.10.100-10.10.10.120</IP_RANGE>
        </IP_SET>
        <ACTION>Added</ACTION>
        <DATETIME>2016-04-29T06:56:13Z</DATETIME>
        <USER_LOGIN>quays_ss</USER_LOGIN>
        <COMMENTS><![CDATA[my comments]]></COMMENTS>
      </HISTORY>
    ...
    </HISTORY_LIST>
    <WARNING>
      <CODE>1980</CODE>
      <TEXT>1,000 record limit exceeded. Use URL to get next batch of results.</TEXT>
<URL><!CDATA[https://qualysapi.qualys.com/api/2.0/fo/asset/excluded_ip/history/?actionlist&id_max1660></URL>
    </WARNING>
    <GLOSSARY>
      <USER_LIST>
        <USER>
          <USER_LOGIN>quays_ss</USER_LOGIN>
          <FIRST_NAME>Sally Unassigned</FIRST_NAME>
          <LAST_NAME>Storm</LAST_NAME>
          <ROLE>Scanner</ROLE>
        </USER>
        <USER>
          <USER_LOGIN>quays_ab</USER_LOGIN>
          <FIRST_NAME>Al</FIRST_NAME>
          <LAST_NAME>Berger</LAST_NAME>
          <ROLE>Manager</ROLE>
        </USER>
      </USER_LIST>
    </GLOSSARY>
  </RESPONSE>
</HISTORY_LIST_OUTPUT>

DTD

<platform API server>/api/2.0/fo/asset/excluded_ip/history/history_list_output.dtd