Skip to main content

Get Cloud Discovery Scan Results​

x-prisma-cloud-target-env: {"permission":"monitorCloud","saas":true,"self-hosted":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

    Offset from the start of the list from which to retrieve documents.

    limit integer

    Number of documents to return.

    search string

    Search term.

    sort string

    Key on which to sort.

    reverse boolean

    Sort order.

    collections string[]

    Scopes the query by collection.

    provider string[]

    Scopes the query by cloud provider.

    accountIDs string[]

    Scopes the query by account ID.

    resourceIDs string[]

    Scopes the query by resource ID.

    region string[]

    Scopes the query by cloud region.

    fields string[]

    List of fields to retrieve.

    credentialID string[]

    CredentialID is the account filter.

Responses
Schema
  • Array [
    • accountID string

    AccountID is the cloud account ID.

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

    entities object[]

    Entities holds detailed scan results.

  • Array [
    • activeServicesCount int64

    ActiveServicesCount is the number of active services in ecs cluster.

    arn string

    The Amazon Resource Name (ARN) assigned to the entity.

    containerGroup string

    ContainerGroup is the azure aci container group the container belongs to.

    createdAt date-time

    CreatedAt is the time when the entity was created.

    defended boolean

    Defended indicates if the entity is defended.

    endpoints string[]

    Endpoints are the cluster endpoints.

    image string

    Image is the image of an aci container.

    lastModified date-time

    LastModified is the modification time of the function.

    name string

    Name is the name of the entity.

    nodesCount integer

    NodesCount is the number of nodes in the cluster (aks, gke).

    resourceGroup string

    ResourceGroup is the the azure resource group containing the entity.

    runningTasksCount int64

    RunningTasksCount is the number of running tasks in ecs cluster.

    runtime string

    Runtime is runtime environment for the function, i.e. nodejs.

    status string

    Status is the current status of entity.

    version string

    Version is the version of the entity.

  • ]
    • err string

    Err holds any error found during a scan.

    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.

  • ]
Loading...