Skip to main content

Resource Scan Info - POST

POST 
/resource/scan_info
deprecated

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

Returns a full breakdown of passed/failed statistics and associated policies for resources.

info

Replacement  Endpoint: Resource Scan Info V2 - POST

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

Filter by Time​

The time filter narrows the response to resources from account onboarding until the point in time of interest.

Time Types​

Time TypeRequired timeRange.value Parameters
to_nowNo timeRange.value parameter required
relativetimeRange.value.amount, timeRange.value.unit
absolutetimeRange.value.endTime (timeRange.value.startTime is ignored)

How Current is the Returned Data?​

Since Prisma Cloud relies on snapshots of data, there can be an hour or two delay between the time a resource passes or fails a policy check and the reporting of that result through this method.

Request​

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

Responses​

success

Schema
    nextPageToken object

    Use as page token to return next page of data

    failedEventOffset boolean
    lastRowIdx int64
    limit int64
    offset int64
    previousTotalMatchedCount int64
    timestamp int64
    pageSize int64

    Page size

    resources object[]

    List of metadata for resources that match filter

  • Array [
    • accountId string

    Account ID

    accountName string

    Account name

    alertStatus object

    Count of alerts found by their policy severity

    critical int64
    high int64
    informational int64
    low int64
    medium int64
    appNames string[]
    assetType string

    Asset Type

    cloudType string

    Possible values: [ALL, AWS, AZURE, GCP, ALIBABA_CLOUD, OCI, IBM]

    Cloud type

    id string

    Resource ID

    name string

    Resource name

    overallPassed boolean

    All policies passed

    regionId string

    Region ID

    regionName string

    Region Name

    resourceConfigJsonAvailable boolean

    Resource config JSON available

    resourceDetailsAvailable boolean

    Resource details available

    rrn string

    RRN

    scannedPolicies object[]

    Scanned policies

  • Array [
    • id string
    labels string[]
    name string
    passed boolean
    severity string

    Possible values: [INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL]

  • ]
    • unifiedAssetId string

    Asset Id

    vulnerabilityStatus object

    Count of vulnerabilities found by their severity

    critical int64
    high int64
    low int64
    medium int64
  • ]
    • timestamp int64

    Epoch timestamp

    totalMatchedCount int64

    Total number of filtered resources, both scanned and unscanned

Loading...