Returns a list of catalog entries based on the search criteria.
Permissions required - You must have the WAS module enabled. You must have the "API access" and "Access WAS module" permissions. You must have the "WAS.CATALOG.ACCESS" permission.
These elements are optional and act as filters. When multiple elements are specified, parameters are combined using a logical AND.
Click here for available operators
|
Parameter |
Mandatory /Optional |
Data Type |
Description |
|---|---|---|---|
|
id |
Optional |
integer |
(integer) The ID of the catalog entry. |
|
ipAddress |
Optional |
text |
(integer) The IP address of the discovered host. We support wild card character * for numbers in IP Address. For example, 10.11.196.* or 10.11.*.* are valid patterns for IP address. Examples of Invalid patterns:*1.123.123.123, 1*1.123.123.123 and 1*.123.123.123 |
|
port |
Optional |
text |
(integer) The port number of the discovered service. |
|
source |
Optional |
text |
(text) The source of the catalog entries. Valid values are: VM_SCAN, VM_MAP, and WAS_SCAN. |
|
Status |
Optional |
integer |
(text) The status of the entry. Valid values are NEW, ROGUE, APPROVED, IGNORED, IN_SUBSCRIPTION. |
|
operatingSystem |
Optional |
date |
(text) The operating system of discovered host. |
|
netbiosName |
Optional |
date |
(text) The NetBIOS name of the discovered host. |
|
fqdn |
Optional |
boolean |
(text) The fully qualified domain name of the discovered host. |
|
createdDate |
Optional |
boolean |
(date) The date and time when the catalog entry is created. The date format is YYYY-MM-DDTHH:MM:SSZ. For example: 2018-05-18T10:33:54Z |
|
UpdatedDate |
Optional |
keyword |
(date) The updated date and time when the catalog entry is updated. The date format is YYYY-MM-DDTHH:MM:SSZ. For example: 2018-05-18T10:33:54Z. |
Let us view all catalog entries in the user’s scope for IP address that contains wild card character.
API request
curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --
data-binary @-
"<qualys_base_url>/qps/rest/3.0/search/was/catalog" <fil.xml
Note: “file.xml” contains the request POST data.
Request POST data
<ServiceRequest>
<filters>
<Criteria field="ipAddress"
operator="EQUALS">10.113.*.*</Criteria>
</filters>
</ServiceRequest>
XML response
<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/qps/xsd/3.0/was/catalog.xsd">
<responseCode>SUCCESS</responseCode>
<count>2</count>
<hasMoreRecords>false</hasMoreRecords>
<data>
<Catalog>
<id>306909</id>
<ipAddress>10.113.196.192</ipAddress>
<port>443</port>
<operatingSystem>Ubuntu / Fedora / Tiny Core Linux / Linux
3.x</operatingSystem>
<source>VM_SCAN</source>
<status>ROGUE</status>
<createdDate>2018-05-18T10:33:55Z</createdDate>
<updatedDate>2020-05-19T13:50:08Z</updatedDate>
<updatedBy>
<id>1918433</id>
<username>qualys_joe</username>
<firstName>
<![CDATA[qualys]]>
</firstName>
<lastName>
<![CDATA[joe]]>
</lastName>
</updatedBy>
</Catalog>
<Catalog>
<id>306906</id>
<ipAddress>10.113.196.18</ipAddress>
<port>80</port>
<operatingSystem>Windows XP Service Pack 2</operatingSystem>
<source>VM_SCAN</source>
<fqdn>10-113-196-18.bogus.tld</fqdn>
<netbiosName>SYS_10_113_196_18</netbiosName>
<status>ROGUE</status>
<createdDate>2018-05-18T10:33:55Z</createdDate>
<updatedDate>2020-05-19T13:50:08Z</updatedDate>
<updatedBy>
<id>1918433</id>
<username>qualys_joe</username>
<firstName>
<![CDATA[qualys]]>
</firstName>
<lastName>
<![CDATA[joe]]>
</lastName>
</updatedBy>
</Catalog>
</data>
</ServiceResponse>