OpenSearch/x-pack/docs/en/rollup/api-quickref.asciidoc

36 lines
878 B
Plaintext

[[rollup-api-quickref]]
== API Quick Reference
experimental[]
Most {rollup} endpoints have the following base:
[source,js]
----
/_xpack/rollup/
----
// NOTCONSOLE
[float]
[[rollup-api-jobs]]
=== /job/
* {ref}/rollup-put-job.html[PUT /job/<job_id+++>+++]: Create a job
* {ref}/rollup-get-job.html[GET /job]: List jobs
* {ref}/rollup-get-job.html[GET /job/<job_id+++>+++]: Get job details
* {ref}/rollup-start-job.html[POST /job/<job_id>/_start]: Start a job
* {ref}/rollup-stop-job.html[POST /job/<job_id+++>+++]: Stop a job
* {ref}/rollup-delete-job.html[DELETE /job/<job_id+++>+++]: Delete a job
[float]
[[rollup-api-data]]
=== /data/
* {ref}/rollup-get-rollup-caps.html[GET /data/<index_name+++>/_rollup_caps+++]: Get Rollup Capabilities
[float]
[[rollup-api-index]]
=== /<index_name>/
* {ref}/rollup-search.html[GET /<index_name>/_rollup_search]: Search rollup data