Delete Catalog Entry

[POST] /qps/rest/3.0/delete/was/catalog/{id}

Deletes a catalog entry that is in your scope. Want to find an ID of a catalog entry to use as input? See Search catalog entries.

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" and "WAS.CATALOG.ENTRY.DELETE" permissions.

Input ParametersInput Parameters

The element “id” (integer) is required, where “id” identifies a catalog entry.

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	Mandatory	integer	The ID of the catalog entry.
ipAddress	Optional	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, 11.123.123.123 and 1*.123.123.123
port	Optional	integer	The port number of the discovered service.
source	Optional	text	The source of the catalog entries. Valid values are: VM_SCAN, VM_MAP, and WAS_SCAN.
Status	Optional	text	The status of the entry. Valid values are NEW, ROGUE, APPROVED, IGNORED, IN_SUBSCRIPTION.
operatingSystem	Optional	text	The operating system of discovered host.
netbiosName	Optional	text	The NetBIOS name of the discovered host.
fqdn	Optional	text	The fully qualified domain name of the discovered host.
createdDate	Optional	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	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.

Sample - Delete a catalog entrySample - Delete a catalog entry

Let us delete a catalog entry with ID 368106.

API request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" "<qualys_base_url>/qps/rest/3.0/delete/was/catalog/368106"

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>1</count>
    <data>
        <Catalog>
            <id>368106</id>
        </Catalog>
    </data>
</ServiceResponse>

Sample - Delete bulk catalog entriesSample - Delete bulk catalog entries

Let us delete catalog entries in the user’s account with the given IDs.

API request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --
data-binary @-
"<qualys_base_url>/qps/rest/3.0/delete/was/catalog/" <file.xml
Note: “file.xml” contains the request POST data.

Request POST data

<ServiceRequest>
    <filters>
        <Criteria field="id" operator="IN">610107,610110</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>
    <data>
        <Catalog>
            <id>610107</id>
        </Catalog>
        <Catalog>
            <id>610110</id>
        </Catalog>
    </data>
</ServiceResponse>