Skip to main content

Asset Inventory View V3 - GET

GET 

/v3/inventory

Returns asset inventory pass/fail data.

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:

groupBygroupedAggregates Includes
not specifiedcloudTypeName
cloudTypecloudTypeName
cloud.accountaccountName
cloud.regionregionName, cloudTypeName
cloud.serviceserviceName, cloudTypeName
resource.typeresourceTypeName, 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

    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

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

    criticalSeverityFailedResources int64

    The number of resources that failed critical severity policies

    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 that failed informational severity policies

    lowSeverityFailedResources int64

    The number of resources that failed low severity policies

    lowVulnerabilityFailedResources int64

    The number of resources that failed with low vulnerabilities

    mediumSeverityFailedResources int64

    The number of resources that failed medium severity policies

    mediumVulnerabilityFailedResources int64

    The number of resources that failed with medium vulnerabilities

    passedResources int64

    Number of passed resources

    timestamp int64

    Timestamp

    totalResources int64

    Total number of resources

    totalVulnerabilityFailedResources int64

    The total number of resources that failed with vulnerabilities

    unscannedResources int64

    Total number of unscanned resources

    timestamp int64

    Timestamp

Loading...