Get cloud scan activity


Use this endpoint to get information about the activities enabled for an existing cloud scan template.

curl --location --request GET '' \
--header 'X-DC-DEVKEY: {{api_key}} ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountId": 126993,
    "searchCriteriaList": [],
    "startIndex": 1,
    "pageSize": 50,
    "sortedColumn": "domain",
    "sortOrder": "ASC"
200 OK
    "error": null,
    "data": {
        "percentage": 0,
        "status": "in_progress",
        "totalCount": 3,
        "cloudscanActivity": [
                "id": 14809443,
                "type": "Included",
                "domain": "",
                "status": "in_progress",
                "updatedDate": 1588786078633,
                "lastCompletedDate": 1588786078633
                "id": 14809442,
                "type": "Included",
                "domain": "",
                "status": "in_progress",
                "updatedDate": 1588786076973,
                "lastCompletedDate": 1588786076973

URL query parameters

Name Req/Opt Type Description
accountId required string Account ID.
divisionId required integer Division ID.
searchCriteriaList optional array Filter results by specified values.
The array includes key, operation, and value.
Example: searchCriteriaList:[{"key":"domain","operation":"EQUALS","value":[""]}]
startIndex optional integer Start at the specified index.
Default: 1
pageSize optional integer Number of records per page.
Allowed values0 to 512
sortedColumn optional string Sort results by specified parameter.
sortOrder optional string Sort direction.
Allowed values: DESC (descending: 9-0, Z-A), ASC (ascending: 0-9, A-Z)
Default: DESC

Response parameters

Name Type Description
error object Includes the error code, if any.
data object Object container for response.
.. percentage integer Completion percentage of the cloud scan.
.. status string Status of the cloud scan.
Possible values: Completed, failed, partial, in_progress
.. totalCount integer Total number of domains present in the cloud scan.
.. cloudscanActivity array List of objects with details about the activities found for the cloud scan template.
.. .. id integer Domain ID.
.. .. type string IP/Domains to be included or excluded.
Possible values: Included, Excluded
.. .. domain string Scanned domain.
.. .. status string Status of scanned domain.
Possible values: Completed, failed, added, in_progress
.. .. updatedDate integer Date when the domain was last updated (epoch in milliseconds).
.. .. lastCompletedDate integer Date when the domain was last scanned via cloud scanner (epoch in milliseconds).