stack es security clone-api-key cli command
Auth required
elastic stack es security clone-api-key --api-key <api-key> [options]
Clone an API key.
Behaviour flags:
--dry-run — validate all inputs and exit without performing any action
--api-keystringrequired- The credentials of the API key to clone. This is the secret value returned when the key was originally created.
--refreshenum-
If
true(the default) then refresh the affected shards to make this operation visible to search, ifwait_forthen wait for a refresh to make this operation visible to search, iffalsethen do nothing with refreshes.Values: true, false, wait_for
--namestring- A name for the cloned API key. If not provided, the name of the source key is used.
--expirationstring- The expiration time for the cloned API key.
By default, API keys never expire.
Set to
nullto explicitly create a key with no expiration. --metadatastring- Arbitrary metadata to associate with the cloned API key.
It supports nested data structure.
Within the metadata object, keys beginning with
_are reserved for system usage. --[no-]error-trace- When set to
trueElasticsearch will include the full stack trace of errors when they occur. --filter-pathstring-
Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.
Repeatable: pass
--filter-pathmultiple times to supply more than one value --[no-]human- When set to
truewill return statistics in a format suitable for humans. For example"exists_time": "1h"for humans and"exists_time_in_millis": 3600000for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. --[no-]pretty- If set to
truethe returned JSON will be "pretty-formatted". Only use this option for debugging only. --input-filestring- path to a JSON file to use as command input
--[no-]dry-run- validate all inputs and exit without performing any action (preview changes without applying them)
--[no-]json-
output as JSON