Search Connectors

[POST] /qps/rest/2.0/search/am/assetdataconnector

Returns a list of asset data connectors that match the provided criteria.

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

Pagination - A maximum of 100 instances are returned by default. To customize this specify a “preferences” tag in the POST body of your request.



Permissions required - Managers with Full Scope.

Input ParametersInput Parameters

Click here for available operators

Parameter

Mandatory

/Optional

Data Type

Description

id

  long

Primary key

name

  string

 

description

  string

 

lastSynch

  date

 

lastError

  string

 

connectorState

  Keyword

(AssetDataConnectorState) PENDING, SUCCESS, ERROR, QUEUED, RUNNING, PROCESSING, FINISHED_SUCCESS, FINISHED_ERRORS, DISABLED, INCOMPLETE, not writeable.

activation

  Keyword

VM, PC, SCA, CERTVIEW

defaultTags.name

  text

The name of a tag in the defaultTags collection

defaultTag

  integer

The ID of a tag in the defaultTags collection

disabled

  boolean

Whether execution of the connector is disabled (YES). If disabled the connector will not synchronize assets.

Sample - Find all asset data connectors with tag name USASample - Find all asset data connectors with tag name USA

API request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @- "<qualys_base_url>/qps/rest/2.0/search/am/assetdataconnector" < file.xml
Note: file.xml contains request POST data      
    

Request POST data

<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
    <filters>
        <Criteria field="defaultTags.name" operator="EQUALS">USA</Criteria>
    </filters>
</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/2.0/am/asset_data_connector.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>13</count>
    <hasMoreRecords>false</hasMoreRecords>
    <data>
        <AssetDataConnector>
            <id>12345</id>
            <name>DB1</name>
            <awsAccountId>205767712438</awsAccountId>
            <lastSync>2014-11-26T08:44:05Z</lastSync>
            <lastError />
            <connectorState>SUCCESS</connectorState>
            <type>AWS</type>
            <defaultTags>
                <list>
                    <TagSimple>
                        <id>3</id>
                        <name>USA</name>
                    </TagSimple>
                </list>
            </defaultTags>
            <activation>
                <ActivationModule>VM</ActivationModule>
                <ActivationModule>PC</ActivationModule>
            </activation>
        </AssetDataConnector>
    </data>
</ServiceResponse>      
    

XSD

<platform API server>/qps/xsd/2.0/am/asset_data_connector.xsd