Returns a list of AWS connectors in the user's account that match the provided criteria. Narrow down your search results using the parameters listed below.
Pagination - A maximum of 100 instances are returned by default. To customize this specify a "preferences" tag in the POST body of your request.
|
Parameter |
Mandatory /Optional |
Data Type |
Description |
|---|---|---|---|
|
id |
The ID of the connector that you want to search. |
||
|
name |
Name of the connector you want to search. |
||
|
description |
Description of the connector you want to search. |
||
|
lastSync |
Last sync date of the connector. |
||
|
lastError |
Last error date of the connector. |
||
|
connectorState |
State of the connector. States include PENDING, SUCCESS,ERROR, QUEUED, RUNNING, PROCESSING,FINISHED_SUCCESS, FINISHED_ERRORS, DISABLED,INCOMPLETE. |
||
|
activation |
Activation of Qualys modules. Includes VM, PC, SCA, CERTVIEW. |
||
|
defaultTags.name |
The name of a tag in the defaultTags collection. |
||
|
defaultTag |
(Integer) The ID of a tag in the defaultTags collection. |
||
|
allRegions |
Whether all regions should be selected. |
||
|
endpoint.region |
AWS region code. |
||
|
disabled |
(Boolean) Whether execution of the connector is disabled (YES). If disabled, the connector does not synchronize assets. |
||
|
appCapability.name |
Connector application capability name. |
||
|
appCapability.tag.name |
Tag name associates with connector identifier. |
API request
curl -u "USERNAME:PASSWORD" -H "Content-type: text/xml" -X "POST" --data-binary @- "<qualys_base_url>/qps/rest/3.0/search/am/awsassetdataconnector"
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/3.0/am/awsassetdataconnector.xsd">
<responseCode>SUCCESS</responseCode>
<count>1</count>
<hasMoreRecords>false</hasMoreRecords>
<data>
<AwsAssetDataConnector>
<id>1680606</id>
<name>AWSConnector API</name>
<awsAccountId>xxxxxxxx</awsAccountId>
<description>Connector created through API automation</description>
<lastSync>2022-04-30T11:58:06Z</lastSync>
<connectorState>FINISHED_SUCCESS</connectorState>
<type>AWS</type>
<defaultTags>
<list>
<TagSimple>
<id>xxxxxxxx</id>
<name>testpod</name>
</TagSimple>
</list>
</defaultTags>
<activation>
<list>
<ActivationModule>CLOUDVIEW</ActivationModule>
<ActivationModule>CERTVIEW</ActivationModule>
<ActivationModule>VM</ActivationModule>
</list>
</activation>
<disabled>false</disabled>
<isGovCloudConfigured>false</isGovCloudConfigured>
<isChinaConfigured>false</isChinaConfigured>
<runFrequency>240</runFrequency>
<isRemediationEnabled>true</isRemediationEnabled>
<connectorAppInfos>
<list>
<ConnectorAppInfoQList>
<list>
<ConnectorAppInfo>
<name>CSA</name>
<identifier>arn:aws:iam::xxxxxxxx:role/test_pod</identifier>
<tagId>xxxxxxxx</tagId>
<tagMetadata>
<id>xxxxxxxx</id>
<name>TestTag</name>
</tagMetadata>
</ConnectorAppInfo>
</list>
</ConnectorAppInfoQList>
<ConnectorAppInfoQList>
<list>
<ConnectorAppInfo>
<name>CI</name>
<identifier>arn:aws:iam::xxxxxxxx:role/test_pod</identifier>
<tagId>xxxxxxxx</tagId>
<tagMetadata>
<id>xxxxxxxx</id>
<name>TestTag</name>
</tagMetadata>
</ConnectorAppInfo>
</list>
</ConnectorAppInfoQList>
<ConnectorAppInfoQList>
<list>
<ConnectorAppInfo>
<name>AI</name>
<identifier>arn:aws:iam::xxxxxxxx:role/test_pod</identifier>
<tagId>xxxxxxxx</tagId>
<tagMetadata>
<id>xxxxxxxx</id>
<name>Tag123</name>
</tagMetadata>
</ConnectorAppInfo>
</list>
</ConnectorAppInfoQList>
</list>
</connectorAppInfos>
<cloudviewUuid>xxxxxxx-6726-xxxx-ad4c-a5fb811a9d72</cloudviewUuid>
<arn>arn:aws:iam::xxxxxxxx:role/Saur_Test_04</arn>
<externalId>pod13-xxxxxx-xxxxx</externalId>
<qualysAwsAccountId>xxxxxxxx</qualysAwsAccountId>
<allRegions>true</allRegions>
</AwsAssetDataConnector>
</data>
</ServiceResponse>
API Request (JSON)
"curl -u""USERNAME:PASSWORD""-X""POST""--data-binary @-""<qualys_base_url>/qps/rest/3.0/search/am/awsassetdataconnector""--header""Accept: application/json""--header""Content-Type: application/json"
Request POST data (JSON)
{
"ServiceRequest":{
"filters":{
"Criteria":[
{
"field":"defaultTags.name",
"operator":"EQUALS",
"value":"USA"
}
]
}
}
}
Response (JSON)
{
"ServiceResponse":{
"data":[
{
"AwsAssetDataConnector":{
"description":"Connector created through API automation",
"name":"AWSConnector API",
"externalId":"pod-3734136-1652751983927",
"isChinaConfigured":"false",
"lastSync":"2022-04-30T11:58:06Z",
"disabled":"false",
"connectorState":"FINISHED_SUCCESS",
"qualysAwsAccountId":"XXXXXXXXXXXX",
"runFrequency":240,
"id":1680606,
"activation":{
"ActivationModule":[
"CLOUDVIEW",
"CERTVIEW",
"VM"
]
},
"cloudviewUuid":"95c9c13b-6726-3ef1-ad4c-a5fb811a9d72",
"type":"AWS",
"isGovCloudConfigured":"false",
"allRegions":"true",
"arn":"arn:aws:iam::XXXXXXXXXXXX:role/sample_user",
"connectorAppInfos":{
"list":[
{
"ConnectorAppInfoQList":{
"list":[
{
"ConnectorAppInfo":{
"name":"CSA",
"identifier":"arn:aws:iam::XXXXXXXXXXXX:role/sample_user",
"tagId":123489465,
"tagMetadata":{
"id":123489465,
"name":"Sample_tag"
}
}
}
]
}
},
{
"..."
},
"isRemediationEnabled":"true"
}
}
],
"hasMoreRecords":"false",
"responseCode":"SUCCESS",
"count":1
}
}