Update Catalog Entry

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

Updates the status and comments for a catalog entry which 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.UPDATE" permissions.

Input ParametersInput Parameters

Parameter

Mandatory

/Optional

Data Type

Description

id

Optional

integer

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

status

Optional

text

This is an optional parameter. The status can be updated to one of these statuses: ROGUE, NEW, APPROVED and IGNORED. IN_SUBSCRIPTION status can not be updated using the Update API.

Comments

Optional

text

This is an optional parameter. You can add comments, but you can not update/delete existing comments.

Sample - Search for catalog entriesSample - Search for catalog entries

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/update/was/catalog/368106" <file.xml
Note: “file.xml” contains the request POST data.
    

Request POST data

<ServiceRequest>
    <data>
        <Catalog>
            <status>ROGUE</status>
            <comments>
                <add>
                    <Comment>
                        <contents>
                            <![CDATA[Comment 1]]>
                        </contents>
                    </Comment>
                </add>
            </comments>
        </Catalog>
    </data>
</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>1</count>
    <data>
        <Catalog>
            <id>368106</id>
        </Catalog>
    </data>
</ServiceResponse>