stack es synonyms put-synonym cli command
Auth required
Idempotent
Scope: global
elastic stack es synonyms put-synonym \
--synonyms-set <synonyms-set> \
--id <id> \
[options]
Create or update a synonym set.
Behaviour flags:
--dry-run — validate all inputs and exit without performing any action
--synonyms-setstringrequired-
The synonym rules definitions for the synonyms set.
Repeatable: pass
--synonyms-setmultiple times to supply more than one value --idstringrequired- The ID of the synonyms set to be created or updated.
--refresh- If
true, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning. Iffalse, analyzers will not be reloaded with the new synonym set --append- If
true, the provided synonym rules are appended to the existing set, with matching IDs overwriting existing rules. Iffalse, the entire synonyms set is replaced with the new synonym rules definitions. --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 --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. --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
--dry-run- validate all inputs and exit without performing any action (preview changes without applying them)
--json-
output as JSON