Skip to main content

Get Cloud Discovery Scan Results​

x-prisma-cloud-target-env: {"permission":"monitorCloud","saas":true,"self-hosted":true}
x-public: true

Returns a list of all cloud discovery scan results in a paginated response.

The entities object and the associated parameters in the response schema is now part of a new API endpoint /api/v1/cloud/discovery/entities.

cURL Request​

Refer to the following cURL example request:

$ curl -k \
  -u <USER> \
  -H 'Content-Type: application/json' \
  -X GET \
  "https://<CONSOLE>/api/v<VERSION>/cloud/discovery"
Query Parameters
    offset integer

    Offsets the result to a specific report count. Offset starts from 0.

    limit integer

    Number of reports to retrieve in a page. For PCCE, the maximum limit is 250. For PCEE, the maximum limit is 50. The default value is 50.

    search string

    Retrieves the result for a search term.

    sort string

    Sorts the result using a key. Refer to the columns in the relevant Prisma Cloud Compute user interface to use them as sort keys.

    reverse boolean

    Sorts the result in reverse order.

    collections string[]

    Filters the result based on collection names that you have defined in Prisma Cloud Compute.

    provider string[]

    Scopes the query by cloud provider.

    accountIDs string[]

    Filters the result based on cloud account IDs.

    resourceIDs string[]

    Scopes the query by resource ID.

    region string[]

    Scopes the query by cloud region.

    fields string[]

    Retrieves the fields that you need in a report. Use the list of fields you want to retrieve. By default, the result shows all fields of data.

    credentialID string[]

    CredentialID is the account filter.

    serviceType string[]

    ServiceType is the service type filter.

    registry string[]

    Registry is the registry filter.

    accountName string[]

    AccountName is the account name filter.

    agentless boolean

    Agentless is the agentless filter.

Responses
Schema
  • Array [
    • accountID string

    AccountID is the cloud account ID.

    accountName string

    AccountName is the cloud account name.

    agentless boolean

    Agentless indicates whether the account is scan by agentless.

    collections string[]

    Collections are the matched result collections.

    credentialId string

    CredentialID is the id reference of the credential used.

    defended integer

    Defended is the number of defended entities (registries, functions, clusters).

    defenseCoverage integer

    DefenseCoverage is the defense coverage.

    err string

    Err holds any error found during a scan.

    nodes integer

    Nodes is the number of nodes.

    project string

    Project is the GCP project that was scanned.

    provider common.CloudProvider

    Possible values: [aws,azure,gcp,alibaba,oci,others]

    CloudProvider represents the cloud provider

    region string

    Region is the region that was scanned, for example: GCP - "us-east-1", Azure - "westus".

    registry string

    Registry is the Azure registry that was scanned, for example: testcloudscanregistry.azurecr.io.

    serviceType shared.ScanResultType

    Possible values: [aws-ecr,aws-lambda,aws-ec2,aws-eks,aws-ecs,aws-s3,aws-config,aws-cloud-trail,aws-kms,aws-cloud-watch,aws-sns,aws-security-hub,aws-secrets-manager,aws-parameter-store,azure-acr,azure-functions,azure-aks,azure-aci,azure-vm,gcp-gcr,gcp-gcf,gcp-gke,gcp-vm,gcp-artifact,oci-instance]

    ScanResultType represents a cloud scan result type

    total integer

    Total is total number of entities found in cloud scan.

    undefended integer

    Undefended is the number of undefended entities (registries, functions, clusters).

    zone string

    Zone is the zone that was scanned, only relevant to GCP.

  • ]
Loading...