1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162 |
- [role="xpack"]
- [[watcher-api-stop]]
- === Stop watch service API
- ++++
- <titleabbrev>Stop watch service</titleabbrev>
- ++++
- .New API reference
- [sidebar]
- --
- For the most up-to-date API details, refer to {api-es}/group/endpoint-watcher[{watcher} APIs].
- --
- Stops the {watcher} service if it is running.
- [[watcher-api-stop-request]]
- ==== {api-request-title}
- `POST _watcher/_stop`
- [[watcher-api-stop-prereqs]]
- ==== {api-prereq-title}
- * You must have `manage_watcher` cluster privileges to use this API. For more
- information, see <<security-privileges>>.
- //[[watcher-api-stop-desc]]
- //==== {api-description-title}
- //[[watcher-api-stop-path-params]]
- //==== {api-path-parms-title}
- [[watcher-api-stop-query-params]]
- ==== {api-query-parms-title}
- include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
- //[[watcher-api-stop-request-body]]
- //==== {api-request-body-title}
- //[[watcher-api-stop-response-body]]
- //==== {api-response-body-title}
- //[[watcher-api-stop-response-codes]]
- //==== {api-response-codes-title}
- [[watcher-api-stop-example]]
- ==== {api-examples-title}
- [source,console]
- --------------------------------------------------
- POST _watcher/_stop
- --------------------------------------------------
- {watcher} returns the following response if the request is successful:
- [source,console-result]
- --------------------------------------------------
- {
- "acknowledged": true
- }
- --------------------------------------------------
|