Asset Inventory View V2 - POST

POST /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 - POST

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.

You can get a list of the valid names and values for the filters body parameter through List Inventory Filters V2.

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

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

If groupBy includes multiple values, then groupedAggregates will include multiple attributes.

Request

application/json

Body

detailed boolean

Detailed

fields string[]

Array of specific fields to return

filters object[]

Filtering parameters.

For filter names, refer to List Filters API.

For filter values, refer to List filter suggestions.

The only exception is resource.tagv2 filter name, provide filter value for it in the following format: "{"key":"'CustomerTagKey'","value":"'CustomerTagValue'"}"

Array [

name string

Name

operator string

Possible values: [tag:yaml.org,2002:value =]

Operator

value string

Value

]

groupBy string[]

For asset or data inventory only. Group returned items by cloud.type, cloud.service, cloud.region, cloud.account, and/or resource.type

limit number

Maximum number of items to return. When data is paginated, maximum number of items per page.The maximum cannot exceed 10,000. The default is 10,000.

offset number

The number of items to skip before selecting items to return. Default is zero

pageToken string

Setting this pagination Token to the nextPageToken from a response object returns the next page of data

sortBy string[]

Array of sort properties. Append :asc or :desc to the key to sort by ascending or descending order respectively. Example sort properties are id:asc and timestamp:desc

timeRange object

See the Time Range Model for details.

oneOf

RelativeTimeRangeConfigModel
AbsoluteTimeRangeConfigModel
ToNowTimeRangeConfigModel

relativeTimeType string

Possible values: [BACKWARD, FORWARD]

Direction in which to count time. Default = BACKWARD

type string

value objectrequired

Model for RelativeTimeDuration

amount int32

Number of time units

unit string

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

Time unit

value string

Possible values: [MINUTE, HOUR, DAY, WEEK, MONTH, YEAR, EPOCH, LOGIN]

Time range object

Responses

success

application/json

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