PASM CLI Checkout-Secret Command

Use the PASM CLI checkout-secret command to check out a secret from a box in your KeyControl PASM Vault. If secret is of "file" type, on checkout, the corresponding secret file is downloaded to your current working directory.

Syntax

pasmcli checkout-secret [options]

Option Description

-h or --help

Displays usage text.

-b or --boxid string

The ID or name of the box where the secret is located. Strings must be enclosed in double quotes.

-d or --dont-save-lease string

When this option is added, the lease information will not be saved in a file.

-j or --json-output string

When this option is added, the JSON-formatted output is displayed.

-l or --lease-file string

The file location where the lease details will be saved upon successful checkout. If neither this option nor the dont-save-lease option is not provided, then the lease details will be stored by default at $HOMEDIR/vault.data/vault_lease_<id>.txt.

-s or --secretid string

The ID or name of the secret to fetch. Strings must be enclosed in double quotes.

-v, or --version int

The version of the secret to fetch in integer format. If not specified, fetch the latest version.