Asset Inventory View V2 - GET

GET /v2/inventory

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Returns asset inventory pass/fail data for the specified time period.

info

Replacement Endpoint: Asset Inventory View V3 - GET

note

This endpoint will only be able to access data from the past 1 year. This change is implemented to optimize system performance and reduce data storage requirements of deprecated endpoints.

The response includes an attribute groupedAggregates, whose content depends on the groupBy query parameter. The following table shows the attributes that groupedAggregates will include for the specified groupBy query parameter:

groupBy	groupedAggregates Includes
not specified	cloudTypeName
cloudType	cloudTypeName
cloud.account	accountName
cloud.region	regionName, cloudTypeName
cloud.service	serviceName, cloudTypeName
resource.type	resourceTypeName, cloudTypeName

If you specify groupBy multiple times in a single request, then groupedAggregates will include multiple attributes. For example, you can set the following in the URL: groupBy=cloud.account&groupBy=cloud.service. Doing so will have the same effect as specifying a comma-separated list of values for groupBy.

Request

Query Parameters

timeType stringrequired

Possible values: [relative]

Time type

timeAmount stringrequired

Number of time units

timeUnit stringrequired

Possible values: [minute, hour, day, week, month, year]

Time unit

cloud.account string

Cloud account

account.group string

Account group

cloud.type string

Cloud type

cloud.region string

Cloud region

cloud.service string

Cloud service

resource.type string

Resource type

groupBy string

Comma-separated list of values by to group response items. Valid values are cloud.type, cloud.account, cloud.region, cloud.service, and/or resource.type. Default is cloud.type.

scan.status string

Possible values: [all, passed, failed]

Whether or not the resources passed or failed the scan. All includes both scanned and unscanned resources.

policy.complianceStandard string

Policy compliance standard name

policy.complianceRequirement string

Policy compliance requirement name

asset.severity string

Policy severity

vulnerability.severity string

Vulnerability Severity

Responses

success

application/json; charset=UTF-8

Schema
Example (from schema)

Schema

groupedAggregates object[]

List of grouped asset inventory aggregates

Array [

accountId string

accountName string

Name of cloud account

allowDrillDown boolean

Possible to drill down further

cloudTypeName string

Name of cloud type

criticalSeverityFailedResources int64

The number of resources whose highest policy failure is critical

criticalVulnerabilityFailedResources int64

The number of resources that failed with critical vulnerabilities

failedResources int64

Number of failed resources

highSeverityFailedResources int64

The number of resources that failed high severity policies

highVulnerabilityFailedResources int64

The number of resources that failed with high vulnerabilities

informationalSeverityFailedResources int64

The number of resources whose highest policy failure is informational

lowSeverityFailedResources int64

The number of resources whose highest policy failure is low

lowVulnerabilityFailedResources int64

The number of resources that failed with low vulnerabilities

mediumSeverityFailedResources int64

The number of resources whose highest policy failure is medium

mediumVulnerabilityFailedResources int64

The number of resources that failed with medium vulnerabilities

passedResources int64

Number of passed resources

regionName string

Name of cloud region

resourceTypeName string

Name of resource type

serviceName string

Name of cloud service

totalResources int64

Total number of Compliance Standard/Requirement/Section scanned resources

totalVulnerabilityFailedResources int64

The total number of resources that failed with vulnerabilities

unscannedResources int64

Total number of unscanned resources

]

requestedTimestamp int64

Requested timestamp

summary object

Model for Asset Inventory Summary