/auth/v1/collections/<collection_ID>: GET

Gets the details of a specific collection.

The following table shows which roles can access this REST API endpoint:
Table 1. Access by role
Data admin Data user Collection Admin Admin Service user
✓ ✓1 ✓1 ✓ X
1 The specified collection must be the one that is assigned to the requesting user ID. If no collection is assigned, then the command fails with error 403, "Not authorized".

Synopsis of the request URL

curl -k  -H ‘Authorization: Bearer <token>’ https://<spectrum_discover_host>/auth/v1/collections/<collection_ID>

Supported request types and response formats

Supported request types:
  • GET
Supported response formats:
  • JSON

Examples

The following example shows how to get the details of a specific collection.

Request: 
curl -k  -H ‘Authorization: Bearer <token>’ https://<spectrum_discover_host>/auth/v1/collections/51d5bf6c7c4e4fd3b35c53ca91d95705

Response:

(200 OK): 
{ 
    "description": "This is a test collection", 
    "domain_id": "default", 
    "enabled": true, 
    "id": "51d5bf6c7c4e4fd3b35c53ca91d95705", 
    "is_domain": false, 
    "name": "test-collection", 
    "parent_id": "default", 
    "tags": [ 
        "tag1", 
        "tag2" 
    ] 
}