Skip to main content

List Inventory Resources

POST 
/dlp/api/v1/inventory/objects/aggregate

Lists resources. The response data depends on the table level you specify in the request body parameters.

The tableLevel and groupBy request body parameters determine which response object fields a successful API request returns.

IF tableLevel is 1 and groupBy is unspecified, the response properties are as shown below:

[
  {
    "cloudType": "",
    "serviceName": "",
    "totalResources": 0,
    "publicResources": ,
    "totalObjects": 0,
    "publicObjects": 0,
    "sensitiveObjects": 0,
    "malwareObjects": 0,
    "alerts": 0
  }
]

If tableLevel is 1 and groupBy is specified, the response properties are as shown below:

[
  {
    "cloudType": "",
    "accountName": "",
    "regionName": "",
    "serviceName": "",
    "totalResources": 0,
    "publicResources": 0,
    "totalObjects": 0,
    "publicObjects": 0,
    "sensitiveObjects": 0,
    "malwareObjects": 0,
    "alerts": 0
  }
]

If tableLevel is 2 and groupBy is unspecified, the response properties are as shown below:

[
  {
    "cloudType": "",
    "serviceName": "",
    "totalResources": 0,
    "publicResources": 0,
    "totalObjects": 0,
    "publicObjects": 0,
    "sensitiveObjects": 0,
    "malwareObjects": 0,
    "alerts": 0
  }
]

If tableLevel is 2 and groupBy = ["cloud.region"], the response properties are as shown below:

[
  {
    "cloudType": "",
    "regionName": "",
    "serviceName": "",
    "totalResources": 0,
    "publicResources": 0,
    "totalObjects": 0,
    "publicObjects": 0,
    "sensitiveObjects": 0,
    "malwareObjects": 0,
    "alerts": 0
  }
]

If tableLevel is 2 and groupBy = ["cloud.account"], the response properties are as shown below:

[
  {
    "cloudType": "",
    "accountName": "",
    "serviceName": "",
    "totalResources": 0,
    "publicResources": 0,
    "totalObjects": 0,
    "publicObjects": 0,
    "sensitiveObjects": 0,
    "malwareObjects": 0,
    "alerts": 0
  }
]

If tableLevel is 2 and groupBy = ["cloud.region", "cloud.account"], the response properties are as shown below:

[
  {
    "cloudType": "",
    "accountName": "",
    "regionName": "",
    "serviceName": "",
    "totalResources": 0,
    "publicResources": 0,
    "totalObjects": 0,
    "publicObjects": 0,
    "sensitiveObjects": 0,
    "malwareObjects": 20,
    "alerts": 0
  }
]

If tableLevel is 3 and groupBy is unspecified, the response properties are as shown below:

[
  {
    "cloudType": "",
    "resourceName": "",
    "publicResource": "",
    "totalObjects": 0,
    "publicObjects": 0,
    "sensitiveObjects": 0,
    "malwareObjects": 0,
    "alerts": 0,
    "bucketRrn":""
  }
]

If tableLevel is 3 and groupBy = ["cloud.account", "cloud.region"], the response properties are as shown below:

[
  {
    "cloudType": "",
    "accountName": "",
    "regionName": "",
    "resourceName": "",
    "publicResource": "",
    "totalObjects": 0,
    "publicObjects": 0,
    "sensitiveObjects": 0,
    "malwareObjects": 0,
    "alerts": 0,
    "bucketRrn":""
  }
]

If tableLevel is 3 and groupBy = ["cloud.region", "cloud.service"], the response properties are as shown below:

[
  {
    "cloudType": "",
    "regionName": "",
    "serviceName": "",
    "resourceName": "",
    "publicResource": "",
    "totalObjects": 0,
    "publicObjects": 0,
    "sensitiveObjects": 0,
    "malwareObjects": 0,
    "alerts": 0,
    "bucketRrn":""
  }
]

If tableLevel is 3 and groupBy = ["cloud.account", "cloud.region", "cloud.service"], the response properties are as shown below:

[
  {
    "cloudType": "",
    "accountName": "",
    "regionName": "",
    "serviceName": "",
    "resourceName": "",
    "publicResource": "",
    "totalObjects": 0,
    "publicObjects": 0,
    "sensitiveObjects": 0,
    "malwareObjects": 0,
    "alerts": 0,
    "bucketRrn":""
  }
]

Request​

Responses​

success