Get Option Profile Details

[GET] /qps/rest/3.0/get/was/optionprofile/<id>

View details for an option profile which is in the user’s scope. See “Search option profiles” to find a record ID to use as input.

Permissions required - User must have WAS module enabled. User account must have these permissions: Access Permission “API Access”. The Output includes option profiles in the user's scope.

Input ParametersInput Parameters

The element “id” (integer) is required, where “id” identifies an option profile.

Click here for available operators

Sample - Get details of an option profile (GET)Sample - Get details of an option profile (GET)

API request

curl -u "USERNAME:PASSWORD" "<qualys_base_url>/qps/rest/3.0/get/was/optionprofile/832265669"

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/optionprofile.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
    <OptionProfile>
        <id>832265669</id>
        <name>
        <![CDATA[My Option Profile]]>
        </name>
        <owner>
        <id>8792415669</id>
        <username>user_walter</username>
        <firstName>
            <![CDATA[Walter]]>
        </firstName>
        <lastName>
            <![CDATA[White]]>
        </lastName>
        </owner>
        <isDefault>false</isDefault>
        <tags>
        <count>0</count>
        </tags>
        <formSubmission>BOTH</formSubmission>
        <maxCrawlRequests>300</maxCrawlRequests>
        <timeoutErrorThreshold>200</timeoutErrorThreshold>
        <unexpectedErrorThreshold>20</unexpectedErrorThreshold>
        <parameterSet>
        <id>0</id>
        <name>
            <![CDATA[Initial Parameters]]>
        </name>
        </parameterSet>
        <ignoreBinaryFiles>false</ignoreBinaryFiles>
        <performance>LOW</performance>
        <bruteforceOption>MINIMAL</bruteforceOption>
        <comments>
        <count>2</count>
        <list>
            <Comment>
            <contents>
                <![CDATA[some comments]]>
            </contents>
            <author>
                <id>200639085669</id>
                <username>user_walter</username>
            </author>
            </Comment>
            <Comment>
            <contents>
                <![CDATA[some more comments]]>
            </contents>
            <author>
                <id>200639085669</id>
                <username>user_walter</username>
            </author>
            </Comment>
        </list>
        </comments>
        <sensitiveContent>
        <creditCardNumber>false</creditCardNumber>
        <socialSecurityNumber>false</socialSecurityNumber>
        </sensitiveContent>
        <createdDate>2017-09-08T22:03:01Z</createdDate>
        <createdBy>
        <id>8792415669</id>
        <username>user_walter</username>
        <firstName>
            <![CDATA[Walter]]>
        </firstName>
        <lastName>
            <![CDATA[White]]>
        </lastName>
        </createdBy>
        <updatedDate>2017-09-08T23:18:28Z</updatedDate>
        <updatedBy>
        <id>8792415669</id>
        <username>user_walter</username>
        <firstName>
            <![CDATA[Walter]]>
        </firstName>
        <lastName>
            <![CDATA[White]]>
        </lastName>
        </updatedBy>
    </OptionProfile>
    </data>
</ServiceResponse>

Sample - Get details on option profile with SmartScan enabled (GET)Sample - Get details on option profile with SmartScan enabled (GET)

Want to use SmartScan? This feature must be enabled for your subscription. We can help you with this quickly - just contact your Technical Account Manager or Qualys Support.

API request

curl -u "USERNAME:PASSWORD" "<qualys_base_url>/qps/rest/3.0/get/was/optionprofile/467333"

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/optionprofile.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
    <OptionProfile>
        <id>467333</id>
        <name>
        <![CDATA[My Option Profile]]>
        </name>
        <owner>
        <id>4354</id>
        <username>user_aril</username>
        <firstName>
            <![CDATA[Ari]]>
        </firstName>
        <lastName>
            <![CDATA[Smith]]>
        </lastName>
        </owner>
        <isDefault>false</isDefault>
        <tags>
        <count>0</count>
        </tags>
        <formSubmission>BOTH</formSubmission>
        <maxCrawlRequests>300</maxCrawlRequests>
        <timeoutErrorThreshold>100</timeoutErrorThreshold>
        <unexpectedErrorThreshold>300</unexpectedErrorThreshold>
        <parameterSet>
        <id>15601</id>
        <name>
            <![CDATA[Test Paramset]]>
        </name>
        </parameterSet>
        <ignoreBinaryFiles>false</ignoreBinaryFiles>
        <smartScanSupport>true</smartScanSupport>
        <smartScanDepth>10</smartScanDepth>
        <performance>LOW</performance>
        <bruteforceOption>MINIMAL</bruteforceOption>
        <comments>
        <count>0</count>
        </comments>
        <sensitiveContent>
        <creditCardNumber>false</creditCardNumber>
        <socialSecurityNumber>false</socialSecurityNumber>
        </sensitiveContent>
        <createdDate>2017-03-23T21:15:47Z</createdDate>
        <createdBy>
        <id>4354</id>
        <username>user_aril</username>
        <firstName>
            <![CDATA[Ari]]>
        </firstName>
        <lastName>
            <![CDATA[Smith]]>
        </lastName>
        </createdBy>
        <updatedDate>2017-03-23T21:15:47Z</updatedDate>
        <updatedBy>
        <id>4354</id>
        <username>user_aril</username>
        <firstName>
            <![CDATA[Ari]]>
        </firstName>
        <lastName>
            <![CDATA[Smith]]>
        </lastName>
        </updatedBy>
    </OptionProfile>
    </data>
</ServiceResponse>

Sample - View details to know if action URI is enabledSample - View details to know if action URI is enabled

Example: View the option profile details for the web application with ID #171683 to check if action URI is enabled or disabled.

API request

curl -u "USERNAME:PASSWORD" " -X GET -H "Content-type: text/xml"
"v/portal-api/rest/3.0/get/was/optionprofile/176683"

XML response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/portal-api/xsd/3.0/was/optionprofile.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
    <OptionProfile>
        <id>176683</id>
        <name>
        <![CDATA[My Option Profile - with action URI]]>
        </name>
        <owner>
        <id>336390</id>
        <username>john_doe</username>
        <firstName>
            <![CDATA[John]]>
        </firstName>
        <lastName>
            <![CDATA[Doe]]>
        </lastName>
        </owner>
        <isDefault>false</isDefault>
        <tags>
        <count>0</count>
        </tags>
        <formSubmission>BOTH</formSubmission>
        <maxCrawlRequests>200</maxCrawlRequests>
        <timeoutErrorThreshold>22</timeoutErrorThreshold>
        <unexpectedErrorThreshold>50</unexpectedErrorThreshold>
        <userAgent>
        <![CDATA[Mozilla/5.0 (Windows NT 6.2; WOW64)AppleWebKit
                   /537.36 (KHTML, like Gecko) Chrome/27.0.1453.116
                   Safari/537.36]]>
        </userAgent>
        <parameterSet>
        <id>0</id>
        <name>
            <![CDATA[Initial Parameters]]>
        </name>
        </parameterSet>
        <ignoreBinaryFiles>true</ignoreBinaryFiles>
        <includeActionUriInFormId>true</includeActionUriInFormId>
        <smartScanSupport>false</smartScanSupport>
        <performance>LOW</performance>
        <bruteforceOption>DISABLED</bruteforceOption>
        <comments>
        <count>1</count>
        <list>
            <Comment>
            <contents>
                <![CDATA[User Comment]]>
            </contents>
            <createdDate>2017-11-18T15:59:55Z</createdDate>
            </Comment>
        </list>
        </comments>
           ...
        
    </OptionProfile>
    </data>
</ServiceResponse>

Sample - Get details of an Option Profile with customized scan intensity (GET)Sample - Get details of an Option Profile with customized scan intensity (GET)

Let us get details of an Option Profile with customized scan intensity.

API request

curl -u "USERNAME:PASSWORD" " -X GET -H "Content-type: text/xml"
"<qualys_base_url>/qps/rest/3.0/get/was/optionprofile/1608560"

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/optionprofile.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <OptionProfile>
            <id>1608560</id>
            <name>
                <![CDATA[Update Option Profile with Custom Scan Intensity]]>
            </name>
            …
            
            <smartScanSupport>false</smartScanSupport>
            <customPerformance>
                <numOfHttpThreads>10</numOfHttpThreads>
                <delayBetweenRequests>20</delayBetweenRequests>
            </customPerformance>
            <bruteforceOption>MINIMAL</bruteforceOption>
            …
        
        </OptionProfile>
    </data>
</ServiceResponse>

Sample - Get details of an option profile with enhanced crawling enabled (GET)Sample - Get details of an option profile with enhanced crawling enabled (GET)

API request

curl -u "USERNAME:PASSWORD" " -X GET -H "Content-type: text/xml"
 "<qualys_base_url>/qps/rest/3.0/get/was/optionprofile/77683"

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/optionprofile.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <OptionProfile>
            <id>77683</id>
            <name>
                <![CDATA[Sample Option Profile]]>
            </name>
            <owner>
                <id>337590</id>
                <username>user_john</username>
                <firstName>
                    <![CDATA[John]]>
                </firstName>
                <lastName>
                    <![CDATA[Doe]]>
                </lastName>
            </owner>
            <isDefault>false</isDefault>
            <tags>
                <count>0</count>
            </tags>
            <formSubmission>BOTH</formSubmission>
            <maxCrawlRequests>300</maxCrawlRequests>
            <timeoutErrorThreshold>100</timeoutErrorThreshold>
            <unexpectedErrorThreshold>300</unexpectedErrorThreshold>
            <parameterSet>
                <id>0</id>
                <name>
                    <![CDATA[Initial Parameters]]>
                </name>
            </parameterSet>
            <ignoreBinaryFiles>false</ignoreBinaryFiles>
            <includeActionUriInFormId>false</includeActionUriInFormId>
            <enhancedCrawling>true</enhancedCrawling>
            <smartScanSupport>false</smartScanSupport>
            ...
        
        </OptionProfile>
    </data>
</ServiceResponse>

Sample - Get details of an option profile to know the detection scope (GET)Sample - Get details of an option profile to know the detection scope (GET)

API request

curl -u "USERNAME:PASSWORD" " -X GET -H "Content-type: text/xml"
 "<qualys_base_url>/qps/rest/3.0/get/was/optionprofile/77683"

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/optionprofile.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <OptionProfile>
            <id>77683</id>
            <name>
                <![CDATA[Sample Option Profile]]>
            </name>
            <owner>
                <id>337590</id>
                <username>user_john</username>
                <firstName>
                    <![CDATA[John]]>
                </firstName>
                <lastName>
                    <![CDATA[Doe]]>
                </lastName>
            </owner>
            <isDefault>false</isDefault>
            <tags>
                <count>0</count>
            </tags>
            <formSubmission>BOTH</formSubmission>
            <maxCrawlRequests>1000</maxCrawlRequests>
            <timeoutErrorThreshold>100</timeoutErrorThreshold>
            <unexpectedErrorThreshold>300</unexpectedErrorThreshold>
            <parameterSet>
                <id>0</id>
                <name>
                    <![CDATA[Initial Parameters]]>
                </name>
            </parameterSet>
            <ignoreBinaryFiles>true</ignoreBinaryFiles>
            <includeActionUriInFormId>false</includeActionUriInFormId>
            <enhancedCrawling>false</enhancedCrawling>
            <smartScanSupport>true</smartScanSupport>
            <smartScanDepth>5</smartScanDepth>
            <performance>LOW</performance>
            <bruteforceOption>MINIMAL</bruteforceOption>
            <detection>
                <detectionScope>EVERYTHING</detectionScope>
            </detection>
            <comments>
                <count>0</count>
            </comments>
            ...
            
        </updatedBy>
    </OptionProfile>
</data>undefined</ServiceResponse>

XSD

<platform API server>/qps/xsd/3.0/was/optionprofile.xsd