NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« xpack.watcher.getWatch xpack.watcher.restart »

› ›

xpack.watcher.putWatch

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

xpack.watcher.putWatch

edit

client.xpack.watcher.putWatch({
  id: string,
  master_timeout: string,
  active: boolean,
  version: number,
  if_seq_no: number,
  if_primary_term: number,
  body: object
})

Reference

`id`	`string` - Watch ID
`master_timeout` or `masterTimeout`	`string` - Explicit operation timeout for connection to master node
`active`	`boolean` - Specify whether the watch is in/active by default
`version`	`number` - Explicit version number for concurrency control
`if_seq_no` or `ifSeqNo`	`number` - only update the watch if the last operation that has changed the watch has the specified sequence number
`if_primary_term` or `ifPrimaryTerm`	`number` - only update the watch if the last operation that has changed the watch has the specified primary term
`body`	`object` - The watch

« xpack.watcher.getWatch xpack.watcher.restart »