pool.dataset.export_key

Export own encryption key for dataset id. If download is true, key will be downloaded in a json file where the same file can be used to unlock the dataset, otherwise it will be returned as string.

Please refer to websocket documentation for downloading the file.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

The dataset ID (full path) to export the encryption key from.
Parameter 2: download

download

Type: boolean Default: false

Whether to prepare the key for download as a file.

Result


The exported encryption key as a hex string, or null if no key is available.

Type: string
Type: null


Required roles: DATASET_WRITE