elasticsearch/docs/reference/rollup/api-quickref.asciidoc
Martijn van Groningen d59ee6cb45
Add documentation around migration from rollup to downsampling (#107965)
This change also updated the deprecation warning on all rollup pages from Rollups will be removed in a future version. Use <<downsampling,downsampling>> instead. to Rollups will be removed in a future version. Please <<rollup-migrating-to-downsampling,migrate>> to <<downsampling,downsampling>> instead..
2024-05-01 08:59:44 +02:00

40 lines
1.3 KiB
Text

[role="xpack"]
[[rollup-api-quickref]]
=== {rollup-cap} API quick reference
++++
<titleabbrev>API quick reference</titleabbrev>
++++
deprecated::[8.11.0,"Rollups will be removed in a future version. Please <<rollup-migrating-to-downsampling,migrate>> to <<downsampling,downsampling>> instead."]
Most rollup endpoints have the following base:
[source,js]
----
/_rollup/
----
// NOTCONSOLE
[discrete]
[[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}
[discrete]
[[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
[discrete]
[[rollup-api-index]]
==== /<index_name>/
* {ref}/rollup-search.html[GET /<index_name>/_rollup_search]: Search rollup data