Get Collection by ID

GET 
/entitlement/api/v1/collection/:id

Returns all details of a Collection.

info

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

Rate Limits

• Request rate limit: 8/sec
• Burst Rate: 8/sec

Request

Path Parameters

id uuidrequired

Collection Id

Responses

200

Successful operation

application/json; charset=UTF-8

Schema

Schema

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

Example (from schema)

{
  "id": "string",
  "name": "string",
  "description": "string",
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdTs": 0,
  "lastModifiedTs": 0,
  "assetGroups": {
    "accountGroupIds": [
      "string"
    ],
    "accountIds": [
      "string"
    ],
    "repositoryIds": [
      "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...