Add a New Collection
POST/api/v32.07/collections
x-prisma-cloud-target-env: {"permission":"collections"}
Creates a new collection. Only the name
field is required; the other fields are optional. The name
field can contain the characters: 'A-Z', 'a-z', '0-9', '_', '-', and ':'. Optional fields for which you do not specify a value are set to the '*' wildcard.
If you don't provide a value for the name
field and try to use the collection, you'll get an empty resource error.
To invoke this endpoint in the Console UI:
- Navigate to Manage > Collections and Tags > Collections.
- Add a collection using + Add collection.
- Click the Save button.
cURL Request
Refer to the following example cURL command that creates a new collection named my-collection
, specifies a HEX color value of #AD3C21, and captures all container images named ubuntu:18.04
:
$ curl 'https://<CONSOLE>:8083/api/v<VERSION>/collections' \
-k \
-X POST \
-u <USER> \
-H 'Content-Type: application/json' \
-d \
'{
"name":"my-collection",
"images":["ubuntu:18.04"],
"hosts":["*"],
"labels":["*"],
"containers":["*"],
"functions":["*"],
"namespaces":["*"],
"appIDs":["*"],
"accountIDs":["*"],
"codeRepos":["*"],
"clusters":["*"],
"color":"#AD3C21"
}'
Note: No response is returned upon successful execution. You must verify the collection in the Console UI.
Request
- application/json
Body
List of account IDs.
List of application IDs.
List of Kubernetes cluster names.
Color is a hexadecimal representation of color code value
List of containers.
Free-form text.
List of functions.
List of hosts.
List of images.
List of labels.
Datetime when the collection was last modified.
Collection name. Must be unique.
List of Kubernetes namespaces.
User who created or last modified the collection.
Indicates whether this collection originates from Prisma Cloud.
Indicates whether this collection was created by the system (i.e., a non user) (true) or a real user (false).
Responses
- 200
- default
OK