Update Azure Connector 3.0
Click to view navigation pane

Update Azure Connector 3.0

POST/qps/rest/3.0/update/am/azureassetdataconnector

POST /qps/rest/3.0/update/am/azureassetdataconnector/<id>

Specify the connector ID and the details of the connector that you would want to update in the request. Your connector details get updated.

Using the NOT EQUALS operator for updating Azure connectors could result in accidental update of unknown Azure connectors without any warning. To prevent accidental updates of unknown Azure connectors, we do not support NOT EQUALS operator for update actions.

Permissions required - Managers with full scope.

Input ParametersInput Parameters

Parameter

Mandatory

/Optional

Data Type

Description

name

    

The ID of the connector that you want to update.

description

    

Name of the connector you want to update.

defaultTags

   TagSimpleQList

Tags applied to any asset discovered by the connector.

activation

   List<ActivationModule>

Assets discovered by the connector is activated for the modules specified.

authRecord

   AzureAuthRecordSimple

The Azure authentication record the connector uses to connect to Azure. When writing/updating it is looked up by the ID field.

disabled

   boolean

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

runFrequency

    

runFrequency for a connector decides the rate at which the connector should poll the cloud provider and fetch the data specified in minutes.

isRemediationEnabled

    

A flag to enable or disable remediation for the connector.

connectorAppInfos.set. ConnectorAppInfoQList

    

A mandatory parent parameter when you need to provide the below parameter, set.ConnectorAppInfo.

connectorAppInfos

    

It holds the list of list of ConnectorAppInfo which includes App. Name, identifiers and tag details. Connector can one or more apps from list [AI, CI, CSA].

AI-Asset Inventory, CI- Cloud Inventory, CSA- Cloud Security Assessment

Input Parameters for Cloud Perimeter ScanInput Parameters for Cloud Perimeter Scan

You can secure publicly exposed cloud assets by enabling cloud perimeter scans for your connectors. Cloud perimeter scans use Qualys External Scanners (Internet Remote Scanners), located at the Qualys Cloud Platform.

You can automate asset discovery of Connectors and with the Cloud Perimeter Scan. This ensures all publicly-exposed assets have perimeter scans performed, based on configurations provided at Connector.

Parameter

Mandatory

/Optional

Data Type

Description

isCPSEnabled

Optional

  

Set this flag to enable or disable cloud perimeter scan for the AWS connector (Note: If isCPSEnabled flag is enabled, you need to provide the below parameters for the Cloud Perimeter Scan).

connectorScanSetting

    

Tag to include cloud perimeter scan settings.

isCustomScanConfig

Enabled

    

Use this flag to indicate the scan configuration to be used for cloud perimeters scan. By default, this flag is disabled and the global scan configuration is applied to the cloud perimeter scan.

To use custom scan configuration, you need to enable this flag.

optionProfileId

    

Specify the Option Profile Id. This Id is unique for every user. You can fetch the option profile Id using the List VM Option Profile API (/api/2.0/fo/subscription/option_profile/vm/?action=list). For more information on the how to fetch the option profile Id, refer to Qualys API (VM, PC) User Guide.

recurrence

    

Specify if the scan should be scheduled on DAILY or WEEKLY basis.

daysOfWeek

    

Specify the days when the scan should be scheduled. For example, SUN, MON, TUE, WED, THU, FRI, SAT.

Note: This field is applicable only if the recurrence field is set to WEEKLY.

scanPrefix

    

Specify a prefix to be appended to the scan name. Once the cloud perimeter scan is triggered from the Vulnerability Management application, the prefix is appended to the scan name. The scan name is in following format:

<prefix>-<connectorId>-<timestamp>

startDate

    

Specify the start date of scan in mm/dd/yyyy format.

startTime

    

Specify the start time of scan in HH:MM (24 hrs) format.

timezone

    

Specify the time zone for the cloud perimeter scan to be initiated.

Sample 1 - Update Azure connector name (single tag)Sample 1 - Update Azure connector name (single tag)

API request

curl -u "USERNAME:PASSWORD" -H "Content-type: text/xml" -X "POST" --data-binary @- "<qualys_base_url>/qps/rest/3.0/update/am/azureassetdataconnector/12345"

Request POST data

<?xml version="1.0" encoding="UTF-8" ?>
<root>
    <ServiceRequest>
        <data>
            <AzureAssetDataConnector>
                <id>2004</id>
                <name>Azure Connector</name>
                <description>Updated Description Via API New1</description>
                <defaultTags>
                    <set>
                        <TagSimple>
                            <id>123488470</id>
                        </TagSimple>
                    </set>
                </defaultTags>
                <activation>
                    <set>
                        <ActivationModule>VM</ActivationModule>
                    </set>
                </activation>
                <authRecord>
                    <applicationId>xxxxxxxxx-694d-xxxx-ae0b-d2bd14d1a4d7</applicationId>
                    <directoryId>xxxxxxxxx-65ab-xxxx-9e5b-1ea02d3d94eb</directoryId>
                    <subscriptionId>xxxxxxxxx-4f67-xxxx-917d-2246853844e1</subscriptionId>
                    <authenticationKey>02LCb8/RCn0lbGj6xxxxxxxxnoH01rog=</authenticationKey>
                </authRecord>
                <disabled>false</disabled>
                <runFrequency>300</runFrequency>
                <isRemediationEnabled>true</isRemediationEnabled>
                <connectorAppInfos>
                    <set>
                        <ConnectorAppInfoQList>
                            <set>
                                <ConnectorAppInfo>
                                    <name>CSA</name>
                                    <identifier>xxxxxxxxx-4f67-xxxx-917d-2246853844e1</identifier>
                                    <tagId>123489465</tagId>
                                </ConnectorAppInfo>
                            </set>
                        </ConnectorAppInfoQList>
                    </set>
                </connectorAppInfos>
            </AzureAssetDataConnector>
        </data>
    </ServiceRequest>
</root>

Response

<?xml version="1.0" encoding="UTF-8" ?>
<ServiceResponse>
    <data>
        <AzureAssetDataConnector>
            <id>842602</id>
        </AzureAssetDataConnector>
    </data>
    <count>1</count>
    <responseCode>SUCCESS</responseCode>
</ServiceResponse>

Sample 2 - Update Azure connector details (multi-tag)Sample 2 - Update Azure connector details (multi-tag)

API Request (JSON)

"curl -u""USERNAME:PASSWORD""-X""POST""--data-binary @-""<qualys_base_url>/qps/rest/3.0/update/am/azureassetdataconnector/12345""--header""Accept: application/json"

Request POST Data (JSON)

{
   "ServiceRequest":{
      "data":{
         "AzureAssetDataConnector":{
            "id":2004,
            "name":"Azure Connector",
            "description":"Updated Description Via API New1",
            "defaultTags": {
                    "set": {
                        "TagSimple": [
                            {
                                "id": 135718404
                            },
                            {
                                "id": 135718404
                            }
                        ]
                    }
                },
            "activation":{
               "set":{
                  "ActivationModule":"VM"
               }
            },
            "authRecord":{
               "applicationId":"f076c321-xxxx-xxxx-xxxx-xxxd14d1a4d7",
               "directoryId":"ff4e2413-xxxx-xxxx-xxxx-1xxxxd3d94eb",
               "subscriptionId":"9de9e0a7-xxxx-xxxx-xxxx-xxxx6853844e1",
               "authenticationKey":"02LCb8YG2z85aSmCxnoH01rog="
            },
            "disabled":false,
            "runFrequency":300,
            "isRemediationEnabled":true,
            "connectorAppInfos":{
               "set":{
                  "ConnectorAppInfoQList":{
                     "set":{
                        "ConnectorAppInfo":{
                           "name":"AI",
                           "identifier":"9de9e0a7-xxxx-xxxx-xxxx-2246853844e1",
                           "tagId":135718404
                        }
                     }
                  },
                  "ConnectorAppInfoQList":{
                     "set":{
                        "ConnectorAppInfo":{
                           "name":"CI",
                           "identifier":"9de9e0a7-xxxx-xxxx-xxxx-2246853844e1",
                           "tagId":135718404
                        }
                     }
                  },
                  "ConnectorAppInfoQList":{
                     "set":{
                        "ConnectorAppInfo":{
                           "name":"CSA",
                           "identifier":"9de9e0a7-xxxx-xxxx-xxxx-2246853844e1",
                           "tagId":123489465
                        }
                     }
                  }
               }
            }
         }
      }
   }
}

Response (JSON)

{
   "ServiceResponse":{
      "data":[
         {
            "AzureAssetDataConnector":{
               "id":842602
            }
         }
      ],
      "count":1,
      "responseCode":"SUCCESS"
   }
}

Sample 3 - Update Azure connector to enable Cloud Perimeter ScanSample 3 - Update Azure connector to enable Cloud Perimeter Scan

API request

curl -u "USERNAME:PASSWORD" -H "Content-type: text/xml" -X "POST" --data-binary @- "<qualys_base_url>/qps/rest/3.0/update/am/azureassetdataconnector/12345"
--header 'Accept: application/json'

Request POST data

<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
    <data>
   ...
      
        <isCPSEnabled>true</isCPSEnabled>
        <connectorScanSetting>
            <isCustomScanConfigEnabled>true</isCustomScanConfigEnabled>
        </connectorScanSetting>
        <connectorScanConfig>
            <set>
                <ConnectorScanConfiguration>
                    <daysOfWeek>
                        <set>
                            <Day>SUN</Day>
                            <Day>MON</Day>
                            <Day>TUE</Day>
                        </set>
                    </daysOfWeek>
                    <optionProfileId>2</optionProfileId>
                    <recurrence>WEEKLY</recurrence>
                    <scanPrefix>update azure 01</scanPrefix>
                    <startDate>31/05/2022</startDate>
                    <startTime>15:45</startTime>
                    <timezone>Africa/Cairo</timezone>
                </ConnectorScanConfiguration>
            </set>
        </connectorScanConfig>
...
    </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/3.0/am/aws_asset_data-connector.xsd">
    <responseCode>SUCCESS</responseCode>
...
  
    <isCPSEnabled>true</isCPSEnabled>
    <connectorScanSetting>
        <isCustomScanConfigEnabled>true</isCustomScanConfigEnabled>
    </connectorScanSetting>
    <connectorScanConfig>
        <set>
            <ConnectorScanConfiguration>
                <daysOfWeek>
                    <set>
                        <Day>SUN</Day>
                        <Day>MON</Day>
                        <Day>TUE</Day>
                    </set>
                </daysOfWeek>
                <optionProfileId>2</optionProfileId>
                <recurrence>WEEKLY</recurrence>
                <scanPrefix>updated- AWS scan prefix</scanPrefix>
                <startDate>31/05/2022</startDate>
                <startTime>15:45</startTime>
                <timezone>Africa/Cairo</timezone>
            </ConnectorScanConfiguration>
        </set>
    </connectorScanConfig>
...
  
</data>undefined</ServiceResponse>

XSD

<platform API server>/qps/xsd/3.0/am/azure_asset_data_connector.xsd