topic Re: Prisma Cloud Compute API filtering in Prisma Cloud Discussions

Prisma Cloud Compute API filtering

AYANG — Wed, 02 Sep 2020 17:58:34 GMT

Hello,

I'm using the Compute/Twistlock API to query image statuses, but I'd like to filter the fields returned to reduce the size of the payload, which contains many things I don't care about for now. I looked at https://cdn.twistlock.com/docs/api/twistlock_api.html#images_get and it mentions a fields query parameter which sounds perfect for my needs, but I haven't been able to find which value has an effect. Passing ?compact=true does work, but it removes things that I need.

Any idea?

Thanks.

Re: Prisma Cloud Compute API filtering

VPersad — Fri, 24 Apr 2020 15:27:45 GMT

Hi,

Here are the list values that you can pass in this API call:

Query Parameters

compact: (boolean)
Compact indicates that only minimum image data should be sent (vulnerabilities, compliance and extended image metadata should be skipped)
fields: (string)
Fields is used to fetch specific image fields
filterBaseImage: (boolean)
FilterBaseImageVulns filters base image vulnerabilities. Requires an existing scan of the base image
hostname: (string)
Hosts is the host filter
id: (string)
IDs is the image id filter
layers: (boolean)
IncludeImageLayers adds image CVEs to image layers
name: (string)
Names is a list of full image names to query by
registry: (string)
Registries is the image registries filter
repository: (string)
Repositories is the image repositories filter
trustStatuses: (string)
TrustStatuses is the trust statuses filter

Re: Prisma Cloud Compute API filtering

PMANKAR — Mon, 26 Jul 2021 14:12:06 GMT

Any idea how do you pass a list of fields to the query parameters.

Re: Prisma Cloud Compute API filtering

VPersad — Wed, 28 Jul 2021 16:07:38 GMT

Hi please the following page for example on how you can pass a list of fields to the query parameters:
https://github.com/twistlock/sample-code/tree/master/computeAPI

Re: Prisma Cloud Compute API filtering

JesseBower — Tue, 21 Sep 2021 20:22:17 GMT

I'd think it would help if we could know the expected format.

E.G. on line 5 we can see the setup for search

https://github.com/twistlock/sample-code/blob/master/computeAPI/scans/getRegistryScan#L5

but what we do not have is any help for the other fields.

E.G.

from	string <date-time> Filters results by start datetime. Based on scan time.

?from=2021-09-01T04:00:00.000Z

to	string <date-time> Filters results by end datetime. Based on scan time.

&to=2034-05-11T04:00:00.000Z

sort	string Key on which to sort.

&sort=entityInfo.scanTime

type	Array of strings (string) Scan type.

&type=ciImage

But the fields option fails to work in testing with expected values from the json payload.

fields

Array of strings (string)

List of fields to retrieve.

what are valid options?

Re: Prisma Cloud Compute API filtering

JesseBower — Wed, 06 Oct 2021 18:26:52 GMT

https://github.com/PaloAltoNetworks/prisma.pan.dev/issues/150 Trying to get us some more info... try the LIVE community the nice voice on hold said.....