Get AWS Connector Info

[GET] /qps/rest/2.0/get/am/awsassetdataconnector/<id>

Returns a single AWS connector by ID.

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

Permissions required - Managers with full scope.

Sample 1 - Fetch the asset data connector with the ID 12345Sample 1 - Fetch the asset data connector with the ID 12345

API request

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="<qualys_base_url>/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>
            <lastSync>2014-11-26T08:44:05Z</lastSync>
...
            <AssetDataConnector>
                <id>12346</id>
                <name>DB2</name>
                <lastSync>2015-01-07T01:50:05Z</lastSync>
...

curl -n -u "USERNAME:PASSWORD" "<qualys_base_url>/qps/rest/2.0/get/am/awsassetdataconnector/12345"

Response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="httpd://qualysapi.qualys.com/qps/xsd/2.0/am/aws_asset_data-connector.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <hasMoreRecords>false</hasMoreRecords>
    <data>
        <AwsAssetDataConnector>
            <id>12345</id>
            <name>new connector</name>
            <awsAccountId>205767712438</awsAccountId>
            <lastSync>2014-11-26T09:27:48Z</lastSync>
            <lastError>Invalid EC2 AuthRecord</lastError>
            <connectorState>ERROR</connectorState>
            <type>AWS</type>
            <defaultTags>
                <list>
                    <TagSimple>
                        <id>1</id>
                        <name>EC2</name>
                    </TagSimple>
                </list>
            </defaultTags>
            <activation>
                <list>
                    <ActivationModule>VM</ActivationModule>
                    <ActivationModule>CLOUDVIEW</ActivationModule>
                </list>
            </activation>
            <arn>arn:aws:iam::205767712433:role/qualys-demo-account</arn>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
            <endpoints>
                <list/>
            </endpoints>
            <allRegions>true</allRegions>
        </AwsAssetDataConnector>
    </data>
</ServiceResponse>

Sample 2 - Fetch the EC2 connector information with the ID 78801, that has CertView module activated.Sample 2 - Fetch the EC2 connector information with the ID 78801, that has CertView module activated.

API request

curl -n -u "USERNAME:PASSWORD" "<qualys_base_url>/qps/rest/2.0/get/am/awsassetdataconnector/78801"

Response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://v-qps1.dev.qualys.com:8080/portal-api/xsd/2.0/am/asset_data_connector.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <AssetDataConnector>
            <id>78801</id>
            <name>cv</name>
            <awsAccountId>383031258652</awsAccountId>
            <lastSync>2019-02-12T23:58:05Z</lastSync>
            <connectorState>FINISHED_SUCCESS</connectorState>
            <type>AWS</type>
            <activation>
                <list>
                    <ActivationModule>CERTVIEW</ActivationModule>
                    <ActivationModule>VM</ActivationModule>
                </list>
            </activation>
            <disabled>false</disabled>
            <isGovCloudConfigured>false</isGovCloudConfigured>
            <isChinaConfigured>false</isChinaConfigured>
        </AssetDataConnector>
    </data>
</ServiceResponse>

Sample 3 - Get connector detailsSample 3 - Get connector details

Here’s how to get details on a connector using GET request. This connector is using ARN. For more information on ARN authentication, refer to Support for Cross-Account Role Authentication.

API request

curl -n -u "USERNAME:PASSWORD"
"<qualys_base_url>/qps/rest/2.0/get/am/awsassetdataconn ector/19201"

curl -n -u "USERNAME:PASSWORD"

"<qualys_base_url>/qps/rest/2.0/get/am/awsassetdataconn ector/19201"

Response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://qualysapi.qualys.com/qps/xsd/2.0/am
/aws_asset_data_connector.xsd"> responseCode>SUCCESS
</responseCode>
<count>1</count>
<data>
    <AwsAssetDataConnector>
        <id>19201</id>
        <name>user_john</name>
        <awsAccountId>205767712438</awsAccountId>
        <lastSync>2018-02-15T12:51:00Z</lastSync>
        <connectorState>FINISHED_SUCCESS</connectorState>
        <type>AWS</type>
        <defaultTags>
            <list/>
        </defaultTags>
        <activation>
            <list>
                <ActivationModule>CLOUDVIEW</ActivationModule>
            </list>
        </activation>
        <disabled>false</disabled>
        <isGovCloudConfigured>false</isGovCloudConfigured>
        <arn>arn:aws:iam::205767712438:role/qualys_dev_test</arn>
        <externalId>pod13-xxxxxx-xxxxx</externalId>
        <qualysAwsAccountId>383031258652</qualysAwsAccountId>
        <endpoints>
            <list>
                <AwsEndpointSimple>
                    <regionCode>ap-south-1</regionCode>
                </AwsEndpointSimple>
            </list>
        </endpoints>
        <allRegions>false</allRegions>
    </AwsAssetDataConnector>
</data>undefined</ServiceResponse>

XSD

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