OpenSearch/docs/reference/rollup/api-quickref.asciidoc
Nik Everett 03daad9812
Re-deprecate xpack rollup endpoints (#36451)
Redeprecates the `/_xpack/rollup` endpoints in favor of `/_rollup`.

When we cleanup the rollup in a cluster containing 6.x nodes we need to
use `/_xpack/rollup` instead of `/_rollup` because the 6.x nodes don't
know about `/_rollup`. In those cases we must ignore the deprecation
warnings that the 7.0 node will return for the end point.

Closes #36044
2018-12-11 19:43:17 -05:00

39 lines
1.1 KiB
Plaintext

[role="xpack"]
[testenv="basic"]
[[rollup-api-quickref]]
== API Quick Reference
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 job
* {ref}/rollup-get-job.html[GET /_rollup/job]: List jobs
* {ref}/rollup-get-job.html[GET /_rollup/job/<job_id+++>+++]: Get job details
* {ref}/rollup-start-job.html[POST /_rollup/job/<job_id>/_start]: Start a job
* {ref}/rollup-stop-job.html[POST /_rollup/job/<job_id>/_stop]: Stop a job
* {ref}/rollup-delete-job.html[DELETE /_rollup/job/<job_id+++>+++]: Delete a 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