Get Policies for a Collection

GET 
/api/v32.04/collections/:id/usages

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

Retrieves all policies that uses a specified collection.

To invoke this endpoint in the Console UI:

1. Navigate to Manage > Collections and Tags > Collections.
2. Click the dotted icon under the Actions column to open up the menu options. Note: The default collections do not have a dotted icon in the Actions column. Use the Manage cog icon to open the update window.
3. Click the Manage button.
4. The Usages table displays the collection's usages.

cURL Request

Refer to the following example cURL command that retrieves all policies with name my-collection:

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

Request

Path Parameters

id stringrequired

Responses

200

application/json

Schema

Schema

• Array [
name string

Name of the consumer (e.g., container runtime, username, etc.).

type collection.UsageType (string)

Possible values: [policy,settings,user,group,registryScan]

UsageType represents a collection usage type

• ]

Example (from schema)

[
  {
    "name": "string",
    "type": [
      "policy",
      "settings",
      "user",
      "group",
      "registryScan"
    ]
  }
]

default

Loading...