API Keys are necessary for configuring endpoints.
$ syntropyctl get-api-keys --help Usage: syntropyctl get-api-keys [OPTIONS] List all API keys. API keys are being used by the endpoint agent to connect to the syntropy platform. By default this command will retrieve up to 128 API keys. You can use --take parameter to get more keys. Options: --skip INTEGER Skip N API keys. --take INTEGER Take N API keys. -j, --json Outputs a JSON instead of a table. --help Show this message and exit.
Generate an API Key for the account:
$ syntropyctl create-api-key --help Usage: syntropyctl create-api-key [OPTIONS] NAME [[%Y-%m-%d %H:%M:%S]] Create a API key for endpoint agent. NOTE: Be sure to remember the API key as it will be only available as a result of this command. Options: -s, --suspended Create a suspended API key. --help Show this message and exit.
syntropyctl create-api-key a-key-for-an-agent
NOTE: The API Key will be printed to the stdout only once. There will be no way to get this API key, so make sure you save it to a safe location.
Removes API Key from Account:
$ syntropyctl delete-api-key --help Usage: syntropyctl delete-api-key [OPTIONS] Delete API key either by name or by id. If there are multiple names - please use id. Options: --name TEXT --id INTEGER -y, --yes Forces to delete all matching networks. --help Show this message and exit.
Updated almost 2 years ago