Get All Collections

GET 
/entitlement/api/v1/collection

Returns all Collections in a paginated format, sorted by ID desc.

info

This endpoint is available on the Prisma Cloud Darwin release only.

Request

Query Parameters

exclude_asset_group boolean

Exclude AssetGroup from response.

page_size int32

Number of records per page. Default is 50 and max is 500.

order_by string

Order by records based of ID, NAME, LAST_MODIFIED_TS.

next_page_token string

Token to fetch next page Collections.

Responses

200

Successful operation

application/json; charset=UTF-8

Schema

Schema

value object[]
Array [
id string
Collection id
name string
Collection name
description string
Collection description
createdBy string
User who created the collection
lastModifiedBy string
User who last updated the collection
createdTs int64
Collection created date
lastModifiedTs int64
Collection last updated date
assetGroups object
AssetGroup that are part of Collection
accountGroupIds string[]
Possible values: <= 5
accountIds string[]
Possible values: <= 1000
repositoryIds string[]
Possible values: <= 1000
]
nextPageToken string

Example (from schema)

{
  "value": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "createdBy": "string",
      "lastModifiedBy": "string",
      "createdTs": 0,
      "lastModifiedTs": 0,
      "assetGroups": {
        "accountGroupIds": [
          "string"
        ],
        "accountIds": [
          "string"
        ],
        "repositoryIds": [
          "string"
        ]
      }
    }
  ],
  "nextPageToken": "string"
}

400

Bad Request

*/*

Schema

Schema

object

Example (from schema)

{}

403

Forbidden

*/*

Schema

Schema

object

Example (from schema)

{}

429

API is rate limited

application/json; charset=UTF-8

Schema

Schema

timestamp stringrequired
httpStatus int32required
error stringrequired
errorDetails object[]
Array [
name stringrequired
message stringrequired
]
message stringrequired
path stringrequired

Example (from schema)

{
  "timestamp": "string",
  "httpStatus": 0,
  "error": "string",
  "errorDetails": [
    {
      "name": "string",
      "message": "string"
    }
  ],
  "message": "string",
  "path": "string"
}

4XX

Client error

application/json; charset=UTF-8

Schema

Schema

timestamp stringrequired
httpStatus int32required
error stringrequired
errorDetails object[]
Array [
name stringrequired
message stringrequired
]
message stringrequired
path stringrequired

Example (from schema)

{
  "timestamp": "string",
  "httpStatus": 0,
  "error": "string",
  "errorDetails": [
    {
      "name": "string",
      "message": "string"
    }
  ],
  "message": "string",
  "path": "string"
}

Loading...