Search Configuration Profiles
Click to view navigation pane

Search Configuration Profiles

[POST] /qps/rest/1.0/search/ca/agentconfig

Returns details on configuration profiles in the user’s account.

Pagination - A maximum of 100 configuration profiles are returned by default. To customize this specify a “preferences” tag in the POST body of your request. Learn more about pagination

Limit your results - Use the optional “fields” parameter to limit the amount of information returned. Learn more about limiting your results

Permissions required - Managers with full scope. Other users must have these permissions: Access Permission “API Access” and CA Configuration Profile Permission “View Configuration Profile”.

Input ParametersInput Parameters

Use the following <ServiceRequest> parameters to filter the list. Filter operators are available for use with <ServiceRequest> parameters.

Supported filter operators

Parameter

Mandatory

/Optional

Data Type

Description

name

Optional

 string

Search for configuration profile with a given name.

id 

Optional

integer

Search for configuration profile with a given configuration profile ID.

Sample - Search configuration profilesSample - Search configuration profiles

API request

curl -u fo_username:password -X POST -H "X-Requested-With: curl" -H "Content-Type: text/xml" -H "Cache-Control: no-cache" --data-binary @get_all_config.xml
"<qualys_base_url>/qps/rest/1.0/search/ca/agentconfig/"
Note: “get_all_config.xml” contains the request POST data.

Contents of get_all_config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest></ServiceRequest>

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/1.0/ca/agentconfig.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>14</count>
    <hasMoreRecords>false</hasMoreRecords>
    <data>
        <AgentConfig>
            <id>8099</id>
            <name>Initial Profile - SSN3</name>
            <isDefault>1</isDefault>
            <createdDate>2015-06-09T22:29:51Z</createdDate>
            <description>Platform Default Config</description>
            <suspendScanning>false</suspendScanning>
            <totalAgents>0</totalAgents>
            <blackoutConfig>
                <settings>
                    <list/>
                </settings>
            </blackoutConfig>
            <performanceProfile>
                <settings>
                    <list>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_PROVISION</key>
                            <value>1800</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_UPLOAD_CHANGELIST</key>
                            <value>5</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>FILE_UPLOAD_FRAGMENT_SIZE_IN_KB</key>
                            <value>1024</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>AGENT_LOGGING_LEVEL</key>
                            <value>Verbose</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>THROTTLE_EVENT_COMM_DOWNLOAD</key>
                            <value>10</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_DOWNLOAD_MANIFEST</key>
                            <value>3600</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>THROTTLE_EVENT_SCAN</key>
                            <value>10</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>FILE_DOWNLOAD_FRAGMENT_SIZE_IN_KB</key>
                            <value>1024</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_DOWNLOAD_SELF_PATCH</key>
                            <value>3600</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_EXECUTE_SETUP</key>
                            <value>300</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_DOWNLOAD_SNAPSHOT</key>
                            <value>120</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>THROTTLE_EVENT_COMM_UPLOAD</key>
                            <value>10</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_STATUS</key>
                            <value>900</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_CONFIG</key>
                            <value>3600</value>
                        </PerformanceLevelSettings>
                    </list>
                </settings>
            </performanceProfile>
        </AgentConfig>
        <AgentConfig>
            <id>9000</id>
            <name>suspend</name>
            <isDefault>0</isDefault>
            <createdDate>2016-02-16T14:55:43Z</createdDate>
            <createdBy>John Doe (john_d)</createdBy>
            <suspendScanning>true</suspendScanning>
            <priority>
                <priority>12</priority>
            </priority>
            <totalAgents>1</totalAgents>
            <blackoutConfig>
                <settings>
                    <list/>
                </settings>
            </blackoutConfig>
            <performanceProfile>
                <settings>
                    <list>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_PROVISION</key>
                            <value>0</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_UPLOAD_CHANGELIST</key>
                            <value>10</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>FILE_UPLOAD_FRAGMENT_SIZE_IN_KB</key>
                            <value>0</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>AGENT_LOGGING_LEVEL</key>
                            <value>Verbose</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>THROTTLE_EVENT_COMM_DOWNLOAD</key>
                            <value>0</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_DOWNLOAD_MANIFEST</key>
                            <value>0</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>THROTTLE_EVENT_SCAN</key>
                            <value>0</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_CHECK_REVOCATION</key>
                            <value>3600</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>FILE_DOWNLOAD_FRAGMENT_SIZE_IN_KB</key>
                            <value>0</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_DOWNLOAD_SELF_PATCH</key>
                            <value>0</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_EXECUTE_SETUP</key>
                            <value>0</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_DOWNLOAD_SNAPSHOT</key>
                            <value>0</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>THROTTLE_EVENT_COMM_UPLOAD</key>
                            <value>0</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_STATUS</key>
                            <value>900</value>
                        </PerformanceLevelSettings>
                        <PerformanceLevelSettings>
                            <key>INTERVAL_EVENT_CONFIG</key>
                            <value>0</value>
                        </PerformanceLevelSettings>
                    </list>
                </settings>
            </performanceProfile>
        </AgentConfig>
...
    </ServiceResponse>

XSD

<platform API server>/qps/xsd/1.0/ca/agentconfig.xsd

© Qualys, Inc. All rights reserved. Privacy Policy.