Create AWS Connector

[POST] /qps/rest/2.0/create/am/awsassetdataconnector

Creates an AWS asset data connector.

disabled (boolean) is used to disable an EC2 connector. This parameter can be set for a “create” or “update” request. When set to “true” the connector is disabled and will not run.

- If a single connector is run and it is disabled an error is returned.

- If multiple connectors are run and all are disabled an error is returned.

- If multiple connectors are run and some are disabled, only connectors that are enabled will run.

Permissions required - Managers with full scope.

Sample 1 - Create new AWS asset data connectorSample 1 - Create new AWS asset data connector

API request

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

Request POST data

<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
    <data>
        <AwsAssetDataConnector>
            <name>V2 Connector</name>
            <arn>arn:aws:iam::xxxxxxxxxxxx:role/CloudView</arn>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
            <defaultTags>
                <set>
                    <TagSimple>
                        <id>xxxxxxxx</id>
                    </TagSimple>
                </set>
            </defaultTags>
            <activation>
                <set>
                    <ActivationModule>VM</ActivationModule>
                </set>
            </activation>
            <allRegions>true</allRegions>
        </AwsAssetDataConnector>
    </data>
</ServiceRequest>

Response

<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://qualysapi.p13.eng.sjc01.qualys.com/qps/xsd/2.0/am/aws_asset_data_connector.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <AwsAssetDataConnector>
            <id>xxxxxx</id>
            <name>V2 Connector</name>
            <awsAccountId>xxxxxxxxxxxx</awsAccountId>
            <lastSync>2022-11-28T10:30:44Z</lastSync>
            <connectorState>QUEUED</connectorState>
            <type>AWS</type>
            <disabled>false</disabled>
            <isGovCloudConfigured>false</isGovCloudConfigured>
            <isChinaConfigured>false</isChinaConfigured>
            <arn>arn:aws:iam::xxxxxxxxxxxx:role/CloudView</arn>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
            <qualysAwsAccountId>xxxxxxxxxxxx</qualysAwsAccountId>
            <allRegions>true</allRegions>
        </AwsAssetDataConnector>
    </data>
</ServiceResponse>

Sample 2 - Create new AWS asset data connector in disabled stateSample 2 - Create new AWS asset data connector in disabled state

API request

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

Request POST data

<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
    <data>
        <AwsAssetDataConnector>
            <name>conn-disabled</name>
            <activation>
                <set>
                    <ActivationModule>VM</ActivationModule>
                    <ActivationModule>PC</ActivationModule>
                </set>
            </activation>
            <arn>arn:aws:iam::205767712433:role/qualys-demo-account</arn>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
            <isGovCloudConfigured>false</isGovCloudConfigured>
            <allRegions>true</allRegions>
            <disabled>true</disabled>
        </AwsAssetDataConnector>
    </data>
</ServiceRequest>

XML output

<?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/aws_asset_data-connector.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <AwsAssetDataConnector>
            <id>254401</id>
            <name>disabled-connector</name>
            <connectorState>DISABLED</connectorState>
            <type>AWS</type>
            <defaultTags>
                <list/>
            </defaultTags>
            <activation>
                <list>
                    <ActivationModule>VM</ActivationModule>
                    <ActivationModule>PC</ActivationModule>
                </list>
            </activation>
            <disabled>true</disabled>
            <isGovCloudConfigured>false</isGovCloudConfigured>
            <endpoints>
                <list>
                    <AwsEndpointSimple>
                        <regionCode>us-west-1</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>ap-northeast-1</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>eu-west-1</regionCode>
                    </AwsEndpointSimple>
...
                    
                    <AwsEndpointSimple>
                        <regionCode>us-east-2</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>me-south-1</regionCode>
                    </AwsEndpointSimple>
                </list>
            </endpoints>
            <allRegions>true</allRegions>
        </AwsAssetDataConnector>
    </data>
</ServiceResponse>

Sample 3 - Create new AWS asset data connector to be available in the CloudView AppSample 3 - Create new AWS asset data connector to be available in the CloudView App

API request

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

Request POST data

<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
    <data>
        <AwsAssetDataConnector>
            <name>ARN Connector</name>
            <arn>arn:aws:iam::205767712433:role/qualys-demo-account</arn>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
            <allRegions>true</allRegions>
            <useForCloudView>true</useForCloudView>
        </AwsAssetDataConnector>
    </data>
</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/aws_asset_data_connector.xsd">''
    
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <AwsAssetDataConnector>
            <id>266408</id>
            <name>conn1</name>
            <awsAccountId> 205767712433</awsAccountId>
            <connectorState>QUEUED</connectorState>
            <type>AWS</type>
            <activation>
                <list>
                    <ActivationModule>CLOUDVIEW</ActivationModule>
                </list>
            </activation>
            <disabled>false</disabled>
            <isGovCloudConfigured>false</isGovCloudConfigured>
            <isChinaConfigured>false</isChinaConfigured>
            <arn>arn:aws:iam::205767712433:role/qualys-demo-account</arn>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
            <qualysAwsAccountId>205767712438</qualysAwsAccountId>
            <endpoints>
                <list>
                    <AwsEndpointSimple>
                        <regionCode>us-west-1</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>ap-northeast-1</regionCode>
                    </AwsEndpointSimple>
                   ...
                
                </list>
            </endpoints>
            <allRegions>true</allRegions>
        </AwsAssetDataConnector>
    </data>
</ServiceResponse>

Sample 4 - Create connectors to include CERTVIEW moduleSample 4 - Create connectors to include CERTVIEW module

API request

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

Request POST data

<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
    <data>
        <AwsAssetDataConnector>
            <name>ARN_Global</name>
            <arn>arn:aws:iam::705355653965:role/Demo-PODs</arn>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
            <allRegions>true</allRegions>
            <activation>
                <set>
                    <ActivationModule>VM</ActivationModule>
                    <ActivationModule>CERTVIEW</ActivationModule>
                </set>
            </activation>
        </AwsAssetDataConnector>
    </data>
</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/aws_asset_data_connector.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <AwsAssetDataConnector>
            <id>566601</id>
            <name>ARN_Global</name>
            <awsAccountId>705355653965</awsAccountId>
            <connectorState>QUEUED</connectorState>
            <type>AWS</type>
            <activation>
                <list>
                    <ActivationModule>CERTVIEW</ActivationModule>
                    <ActivationModule>VM</ActivationModule>
                </list>
            </activation>
            <disabled>false</disabled>
            <isGovCloudConfigured>false</isGovCloudConfigured>
            <isChinaConfigured>false</isChinaConfigured>
            <arn>arn:aws:iam::705355653965:role/Demo-PODs</arn>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
            <qualysAwsAccountId>383031258652</qualysAwsAccountId>
            <endpoints>
                <list>
                    <AwsEndpointSimple>
                        <regionCode>us-west-1</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>ap-northeast-1</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>eu-west-1</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>eu-central-1</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>ap-southeast-1</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>us-east-1</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>ca-central-1</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>eu-west-2</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>ap-southeast-2</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>sa-east-1</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>ap-northeast-2</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>ap-south-1</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>us-west-2</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>us-east-2</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>eu-west-3</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>me-south-1</regionCode>
                    </AwsEndpointSimple>
                </list>
            </endpoints>
            <allRegions>true</allRegions>
        </AwsAssetDataConnector>
    </data>
</ServiceResponse>

Sample 5 - Create Connector with specific regions using V2 APIsSample 5 - Create Connector with specific regions using V2 APIs

API request

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

Request POST data

<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
    <data>
        <AwsAssetDataConnector>
            <name>new connector</name>
            <arn>arn:aws:iam::XXXXXXXXXXXX:role/ARN_UPGRADE</arn>
            <isGovCloudConfigured>false</isGovCloudConfigured>
            <defaultTags>
                <set>
                    <TagSimple>
                        <id>1</id>
                    </TagSimple>
                </set>
            </defaultTags>
            <endpoints>
                <add>
                    <AwsEndpointSimple>
                        <regionCode>af-south-1</regionCode>
                    </AwsEndpointSimple>
                    <AwsEndpointSimple>
                        <regionCode>eu-south-1</regionCode>
                    </AwsEndpointSimple>
                </add>
            </endpoints>
            <activation>
                <set>
                    <ActivationModule>VM</ActivationModule>
                </set>
            </activation>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
            <allRegions>false</allRegions>
        </AwsAssetDataConnector>
    </data>
</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/aws_asset_data_connector.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <AwsAssetDataConnector>
            <id>1998946</id>
            <name>&amp;gt;new connector</name>
            <awsAccountId>XXXXXXXXXXXX</awsAccountId>
            <lastSync>2023-01-13T10:52:17Z</lastSync>
            <connectorState>SUCCESS</connectorState>
            <type>AWS</type>
            <defaultTags>
                <list>
                    <TagSimple>
                        <id>1</id>
                        <name>EC2</name>
                    </TagSimple>
                </list>
            </defaultTags>
            <activation>
                <set>
                    <ActivationModule>VM</ActivationModule>
                </set>
            </activation>
            <disabled>false</disabled>
            <isGovCloudConfigured>false</isGovCloudConfigured>
            <isChinaConfigured>false</isChinaConfigured>
            <arn>arn:aws:iam::XXXXXXXXXXXX:role/ARN_UPGRADE</arn>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
            <qualysAwsAccountId>205767712438</qualysAwsAccountId>
            <allRegions>false</allRegions>
        </AwsAssetDataConnector>
    </data>
</ServiceResponse>

Sample 6 - Create AWS Gov Cloud Connector with specific regions using V2 APIsSample 6 - Create AWS Gov Cloud Connector with specific regions using V2 APIs

API request

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

Request POST data

<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
    <data>
        <AwsAssetDataConnector>
            <name>gov-cloud</name>
            <arn>arn:aws:iam::XXXXXXXXXXXX:role/GOV_ARN</arn>
            <allRegions>false</allRegions>
            <isGovCloudConfigured>true</isGovCloudConfigured>
            <endpoints>
                <add>
                    <AwsEndpointSimple>
                        <regionCode>us-gov-west-1</regionCode>
                    </AwsEndpointSimple>
                </add>
            </endpoints>
            <activation>
                <set>
                    <ActivationModule>VM</ActivationModule>
                </set>
            </activation>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
        </AwsAssetDataConnector>
    </data>
</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/aws_asset_data_connector.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <AwsAssetDataConnector>
            <id>2000148</id>
            <name>gov-cloud</name>
            <awsAccountId>XXXXXXXXXXXX</awsAccountId>
            <lastSync>2023-01-13T11:03:53Z</lastSync>
            <connectorState>SUCCESS</connectorState>
            <type>AWS</type>
            <activation>
                <set>
                    <ActivationModule>VM</ActivationModule>
                </set>
            </activation>
            <disabled>false</disabled>
            <isGovCloudConfigured>true</isGovCloudConfigured>
            <isChinaConfigured>false</isChinaConfigured>
            <arn>arn:aws:iam::XXXXXXXXXXXX:role/GOV_ARN</arn>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
            <qualysAwsAccountId>XXXXXXXXXXXX</qualysAwsAccountId>
            <allRegions>false</allRegions>
        </AwsAssetDataConnector>
    </data>
</ServiceResponse>

Sample 7 - Create AWS China Cloud Connector with specific regions using V2 APIsSample 7 - Create AWS China Cloud Connector with specific regions using V2 APIs

API request

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

Request POST data

<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
    <data>
        <AwsAssetDataConnector>
            <name>cn-conn1</name>
            <arn>arn:aws:iam::XXXXXXXXXXXX:role/CHINA_ARN</arn>
            <allRegions>false</allRegions>
            <isChinaConfigured>true</isChinaConfigured>
            <endpoints>
                <add>
                    <AwsEndpointSimple>
                        <regionCode>cn-northwest-1</regionCode>
                    </AwsEndpointSimple>
                </add>
            </endpoints>
            <activation>
                <set>
                    <ActivationModule>VM</ActivationModule>
                </set>
            </activation>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
        </AwsAssetDataConnector>
    </data>
</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/aws_asset_data_connector.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
    <data>
        <AwsAssetDataConnector>
            <id>2000149</id>
            <name>cn-conn1</name>
            <awsAccountId>XXXXXXXXXXXX</awsAccountId>
            <lastSync>2023-01-13T11:03:53Z</lastSync>
            <connectorState>SUCCESS</connectorState>
            <type>AWS</type>
            <activation>
                <set>
                    <ActivationModule>VM</ActivationModule>
                </set>
            </activation>
            <disabled>false</disabled>
            <isGovCloudConfigured>false</isGovCloudConfigured>
            <isChinaConfigured>true</isChinaConfigured>
            <arn>arn:aws:iam::XXXXXXXXXXXX:role/CHINA_ARN</arn>
            <externalId>pod13-xxxxxx-xxxxx</externalId>
            <qualysAwsAccountId>383031258652</qualysAwsAccountId>
            <allRegions>false</allRegions>
        </AwsAssetDataConnector>
    </data>
</ServiceResponse>

XSD

<platform API server>/qps/xsd/2.0/am/aws_asset_data-connector.xsd