OpenSearch/watcher/docs/reference/rest.asciidoc

[[api-rest]]
=== REST API

include::rest/put-watch.asciidoc[]

include::rest/get-watch.asciidoc[]

include::rest/delete-watch.asciidoc[]

include::rest/execute-watch.asciidoc[]

include::rest/ack-watch.asciidoc[]

include::rest/activate-watch.asciidoc[]

include::rest/deactivate-watch.asciidoc[]

include::rest/info.asciidoc[]

include::rest/stats.asciidoc[]

include::rest/stop.asciidoc[]

include::rest/start.asciidoc[]

include::rest/restart.asciidoc[]
initial migration of watcher Original commit: elastic/x-pack-elasticsearch@b70f48d25ce82b66f35d89b640c7ccdec2846545 2015-07-13 12:23:07 +02:00			`[[api-rest]]`
			`=== REST API`

			`include::rest/put-watch.asciidoc[]`

			`include::rest/get-watch.asciidoc[]`

			`include::rest/delete-watch.asciidoc[]`

			`include::rest/execute-watch.asciidoc[]`

			`include::rest/ack-watch.asciidoc[]`

Introducing Watch De/activateion Today, once you add a watch to watcher, it's always active. Being "active" means that the watch is registered with the trigger engine (scheduled) and will be executed when its trigger is triggered. Quite often, ppl want to have an option to deactivate/disable a registered watch. Such that while the watch definition still exists in watcher, it is "inactive" and is never triggered. The only way to do this today is using a "hack" where you can change the watch schedule to a cron expression targeting a really far date in the future (say somewhere around 2050). Again.. this is very hackish and it requires changing the actual definition of the watch (you loose its original trigger). This commit introduces the notion of an active/inactive watch.. here are the differences between the two states: - active: the watch is registered with watcher and with the trigger engine and will be executed when its trigger is fired by the engine - inactive: the watch is registered with watcher, but is not registered with the trigger engine. An inactive watch will never be fired, regardless of its trigger. This commit also adds two new APIs: - `_watcher/watch/{id}/_activate` - `_watcher/watch/{id}/_deactivate` to activate and deactivate existing watches. In addition, the Put Watch API now accepts an `active` parameter that indicates the initial state of the put watch (by default set to `true`, i.e. "active"). Closes elastic/elasticsearch#90 Original commit: elastic/x-pack-elasticsearch@37b9ab4d5469f2e5761b55ea7e2dc5955de0283b 2015-09-04 01:55:40 +02:00			`include::rest/activate-watch.asciidoc[]`

			`include::rest/deactivate-watch.asciidoc[]`

initial migration of watcher Original commit: elastic/x-pack-elasticsearch@b70f48d25ce82b66f35d89b640c7ccdec2846545 2015-07-13 12:23:07 +02:00			`include::rest/info.asciidoc[]`

			`include::rest/stats.asciidoc[]`

			`include::rest/stop.asciidoc[]`

			`include::rest/start.asciidoc[]`

			`include::rest/restart.asciidoc[]`