Get list of AWS connectors

List all AWS connectors in the user's account.

GET/rest/v1/aws/connectors

Input ParametersInput Parameters

Parameter

Mandatory/Optional

Data Type

Description

filter

Optional String

Filter the connectors list by providing a query using Qualys syntax. The following search tokens are supported.

- name: Name of the connector

- description: Short description of the connector

- state: Connector status The valid values are SUCCESS, PENDING, REGIONS_DISCOVERED, ERROR

- connector.uuid: Unique Id assigned to the connector. For example, 6192ce15-e790-3fe2-a02c-b4bc75ecf123"

- lastSyncedOn: Date and time when the connector synced with the cloud provider.

Note: This time should be in UTC time

pageNo

Optional Integer

The page to be returned.

pageSize

Optional Integer

The number of records per page to be included in the response.

sort

Optional Keyword

Sort the results using a Qualys token. Sorting is currently enabled with only one sort token: lastSyncedOn. The allowed values are asc or desc.

Sample - Get list of AWS connectors in user's accountSample - Get list of AWS connectors in user's account

Return the list of all AWS connectors in the user’s scope.

API request

    
      curl -k -X GET -u <username>:<password>
      '<qualys_base_url>/cloudview-api/rest/v1/aws/connectors?pageNo=0&pageSize=50'
      

Response

    
      { "groups": [],
"pollingFrequency": {
    "hours": 4,
    "minutes": 0
},
"error": "",
"baseAccountId": "XXXXXXXXXXX",
"externalId": "USPOD01-4765-9011278609223",
"arn": "arn:aws:iam::XXXXXXXXXXXX:role/user_new_connector",
"portalConnectorUuid": "2d39470f-cf33-45e3-8b12-ee5916bf18c9",
"isPortalConnector": true
}
],
"pageable": {
"sort": {
"sorted": false,
"unsorted": true
},
"pageSize": 50,
"pageNumber": 0,
"offset": 0,
"paged": true,
"unpaged": false
},
"totalElements": 1,
"last": true,
"totalPages": 1,
"first": true,
"sort": {
"sorted": false,
"unsorted": true
},
"numberOfElements": 1,
"size": 50,
"number": 0
}
            

Sample - Filter the list of AWS connectors in success state and sort in descending order with lastSyncedOnSample - Filter the list of AWS connectors in success state and sort in descending order with lastSyncedOn

API request

    
      curl -k -X GET -u <username>:<password>
      '<qualys_base_url>/cloudview-api/rest/v1/aws/connectors?filter=state%3DSUCCESS&pageNo=1&pageSize=50&sort=lastSyncedOn%3Adesc"
      

Response

    
      {
    "content": [
        {
            "name": "test",
            "connectorId": "6192ce15-e790-3fe2-a02c-b4bc75ec1234",
            "description": "sample description",
            "provider": "AWS",
            "state": "SUCCESS",
            "totalAssets": 5484,
            "lastSyncedOn": "Thu Nov 26 07:21:36 UTC 2020",
            "nextSyncedOn": "Thu Nov 26 09:00:41 UTC 2020",
            "remediationEnabled": true,
            "isGovCloud": false,
            "isDisabled": false,
            "isChinaRegion": false,
            "awsAccountId": "XXXXXXXXXXXX",
            "accountAlias": "alias-test",
            "groups": [
                {
                    "name": "group1",
                    "uuid": "3ce54f33-81c6-30a2-b160-82e70cd1234"
                }
            ],
            "pollingFrequency": {
                "hours": 7,
                "minutes": 0
            },
            "error": "",
            "baseAccountId": "XXXXXXXXXXXX",
            "externalId": "USPOD01-4765-9011278609223",
            "arn": "arn:aws:iam::XXXXXXXXXXXX:role/test",
            "isPortalConnector": false
        },
        ,
  
        
    "numberOfElements": 2,
        "size": 50,
        "number": 0
    }