33 lines
1006 B
Plaintext
33 lines
1006 B
Plaintext
|
--
|
||
|
|
:api: ccr-pause-auto-follow-pattern
|
||
|
|
:request: PauseAutoFollowPatternRequest
|
||
|
|
:response: AcknowledgedResponse
|
||
|
|
--
|
||
|
|
[role="xpack"]
|
||
|
|
[id="{upid}-{api}"]
|
||
|
|
=== Pause Auto Follow Pattern API
|
||
|
|
|
||
|
|
[id="{upid}-{api}-request"]
|
||
|
|
==== Request
|
||
|
|
|
||
|
|
The Pause Auto Follow Pattern API allows you to pause an existing auto follow pattern.
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> The name of the auto follow pattern.
|
||
|
|
|
||
|
|
[id="{upid}-{api}-response"]
|
||
|
|
==== Response
|
||
|
|
|
||
|
|
The returned +{response}+ indicates if the pause auto follow pattern request was received.
|
||
|
|
|
||
|
|
["source","java",subs="attributes,callouts,macros"]
|
||
|
|
--------------------------------------------------
|
||
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
||
|
|
--------------------------------------------------
|
||
|
|
<1> Whether or not the pause auto follow pattern request was acknowledged.
|
||
|
|
|
||
|
|
include::../execution.asciidoc[]
|