Skip to main content

Get Collections

GET 
/api/v33.01/collections
x-prisma-cloud-target-env: {"permission":"collections"}

Retrieves a list of all collections.

This endpoint maps to the table in Manage > Collections and Tags > Collections in the Console UI.

cURL Request​

Refer to the following example cURL command that returns a list of collections:

$ curl -k \
  -u <USER> \
  -H 'Content-Type: application/json' \
  -X GET \
  'https://<CONSOLE>/api/v<VERSION>/collections'

Request​

Query Parameters

    excludePrisma boolean

    ExcludePrisma indicates to exclude Prisma collections.

    prisma boolean

    Prisma filters the collections originates from Prisma Cloud.

    system boolean

    System.

Responses​

Schema
  • Array [
    • accountIDs string (string)[]

    List of account IDs.

    appIDs string (string)[]

    List of application IDs.

    clusters string (string)[]

    List of Kubernetes cluster names.

    color common.Color (string)

    Color is a hexadecimal representation of color code value

    containers string (string)[]

    List of containers.

    description string

    Free-form text.

    functions string (string)[]

    List of functions.

    hosts string (string)[]

    List of hosts.

    images string (string)[]

    List of images.

    labels string (string)[]

    List of labels.

    modified date-time

    Datetime when the collection was last modified.

    name string

    Collection name. Must be unique.

    namespaces string (string)[]

    List of Kubernetes namespaces.

    owner string

    User who created or last modified the collection.

    prisma boolean

    Indicates whether this collection originates from Prisma Cloud.

    system boolean

    Indicates whether this collection was created by the system (i.e., a non user) (true) or a real user (false).

  • ]
Loading...