honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/ilm/apis/ilm-api.asciidoc

45 lines
1.1 KiB
Plaintext
Raw Normal View History

initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples
2018-10-16 15:18:54 -04:00
[[index-lifecycle-management-api]]
[DOCS] Synchs titles of X-Pack APIs
2018-12-20 13:23:28 -05:00
== {ilm-cap} API
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples
2018-10-16 15:18:54 -04:00
Link ILM management and policy information in ILM API documentation (#37324) Previously these were only linked in a circuitous way rather than being available from the top level API documentation and "Put Lifecycle" API docs. This makes them slightly easier to find for a user.
2019-01-10 14:34:44 -05:00
You can use the following APIs to manage policies on indices. See
<<index-lifecycle-management,Managing the index lifecycle>> for more information
about Index Lifecycle Management.
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples
2018-10-16 15:18:54 -04:00
[float]
[[ilm-api-policy-endpoint]]
[DOCS] Synchs titles of X-Pack APIs
2018-12-20 13:23:28 -05:00
=== Policy management APIs
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples
2018-10-16 15:18:54 -04:00
[DOCS] Synchs titles of X-Pack APIs
2018-12-20 13:23:28 -05:00
* <<ilm-put-lifecycle,Create lifecycle policy>>
* <<ilm-get-lifecycle,Get lifecycle policy>>
* <<ilm-delete-lifecycle,Delete lifecycle policy>>
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples
2018-10-16 15:18:54 -04:00
[float]
[[ilm-api-index-endpoint]]
[DOCS] Synchs titles of X-Pack APIs
2018-12-20 13:23:28 -05:00
=== Index management APIs
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples
2018-10-16 15:18:54 -04:00
[DOCS] Synchs titles of X-Pack APIs
2018-12-20 13:23:28 -05:00
* <<ilm-move-to-step,Move index to step>>
* <<ilm-retry-policy,Retry policy on indices>>
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples
2018-10-16 15:18:54 -04:00
[float]
[[ilm-api-management-endpoint]]
[DOCS] Synchs titles of X-Pack APIs
2018-12-20 13:23:28 -05:00
=== Operation management APIs
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples
2018-10-16 15:18:54 -04:00
[DOCS] Synchs titles of X-Pack APIs
2018-12-20 13:23:28 -05:00
* <<ilm-get-status,Get ILM operation mode>>
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples
2018-10-16 15:18:54 -04:00
* <<ilm-start,Start ILM>>
* <<ilm-stop,Stop ILM>>
ILM API ref edits (#35112) * [DOCS] ILM API Ref edits * [DOCS] Fixed endpoint for DELETE policy. * [DOCS] Removed comparison to setting index.lifecycle.name to null. * [DOCS] Fixed xrefs to explain API.
2018-11-08 18:26:27 -05:00
* <<ilm-explain-lifecycle,Explain API>>
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples
2018-10-16 15:18:54 -04:00
include::put-lifecycle.asciidoc[]
include::get-lifecycle.asciidoc[]
include::delete-lifecycle.asciidoc[]
include::move-to-step.asciidoc[]
[ILM] add HLRC docs to remove-policy-from-index (#35759) This primarily introduces documentation for the HLRC remove-policy-from-index action.
2018-11-27 16:28:58 -05:00
include::remove-policy-from-index.asciidoc[]
initial api reference docs for ILM (#33866) This adds the bulk of the ILM APIs in docs with examples
2018-10-16 15:18:54 -04:00
include::retry-policy.asciidoc[]
include::get-status.asciidoc[]
include::explain.asciidoc[]
include::start.asciidoc[]
include::stop.asciidoc[]