42 lines
1.2 KiB
Plaintext
42 lines
1.2 KiB
Plaintext
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[rollup-api-quickref]]
|
|
=== {rollup-cap} API quick reference
|
|
++++
|
|
<titleabbrev>API quick reference</titleabbrev>
|
|
++++
|
|
|
|
experimental[]
|
|
|
|
Most rollup endpoints have the following base:
|
|
|
|
[source,js]
|
|
----
|
|
/_rollup/
|
|
----
|
|
// NOTCONSOLE
|
|
|
|
[float]
|
|
[[rollup-api-jobs]]
|
|
==== /job/
|
|
|
|
* {ref}/rollup-put-job.html[PUT /_rollup/job/<job_id+++>+++]: Create a {rollup-job}
|
|
* {ref}/rollup-get-job.html[GET /_rollup/job]: List {rollup-jobs}
|
|
* {ref}/rollup-get-job.html[GET /_rollup/job/<job_id+++>+++]: Get {rollup-job} details
|
|
* {ref}/rollup-start-job.html[POST /_rollup/job/<job_id>/_start]: Start a {rollup-job}
|
|
* {ref}/rollup-stop-job.html[POST /_rollup/job/<job_id>/_stop]: Stop a {rollup-job}
|
|
* {ref}/rollup-delete-job.html[DELETE /_rollup/job/<job_id+++>+++]: Delete a {rollup-job}
|
|
|
|
[float]
|
|
[[rollup-api-data]]
|
|
==== /data/
|
|
|
|
* {ref}/rollup-get-rollup-caps.html[GET /_rollup/data/<index_pattern+++>/_rollup_caps+++]: Get Rollup Capabilities
|
|
* {ref}/rollup-get-rollup-index-caps.html[GET /<index_name+++>/_rollup/data/+++]: Get Rollup Index Capabilities
|
|
|
|
[float]
|
|
[[rollup-api-index]]
|
|
==== /<index_name>/
|
|
|
|
* {ref}/rollup-search.html[GET /<index_name>/_rollup_search]: Search rollup data
|