Elastic Stack

Elastic Stack (ELK Stack) Ilm API

The ilm API from Elastic Stack (ELK Stack) — 10 operation(s) for ilm.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /_ilm/policy/{policy} Get a specific lifecycle policy · Get lifecycle policies #
Ask an LLM
“How do I see the phases and actions of one index lifecycle policy?”
“What version is a particular ILM policy at?”
Tell an agent
Get lifecycle policy {policy}.
Show the phases defined in ILM policy {policy}.
PUT /_ilm/policy/{policy} Create or update a lifecycle policy · Create or update a lifecycle policy #
Ask an LLM
“How do I create a policy that rolls over indices and deletes them after 30 days?”
“Can I roll back an ILM policy to an earlier version after replacing it?”
Tell an agent
Create lifecycle policy {policy} with definition {policy_body}.
Replace ILM policy {policy} with new phases {policy_body}.
DELETE /_ilm/policy/{policy} Delete a lifecycle policy · Delete a lifecycle policy #
Ask an LLM
“How do I delete an ILM policy I no longer need?”
“Why does deleting a lifecycle policy fail when indices still use it?”
Tell an agent destructive · confirm first
Delete lifecycle policy {policy}.
Remove unused ILM policy {policy}.
GET /{index}/_ilm/explain Explain an index's lifecycle state · Explain the lifecycle state #
Ask an LLM
“What phase and step is my index in right now?”
“Which indices are stuck in an ILM error?”
Tell an agent
Explain the lifecycle state of {index}.
Show only ILM errors for {index} with only_errors {only_errors}.
GET /_ilm/policy List all lifecycle policies · Get lifecycle policies #
Ask an LLM
“Which index lifecycle policies exist on my cluster?”
“How do I get every ILM policy in one call?”
Tell an agent
List all lifecycle policies.
Show every ILM policy with a master timeout of {master_timeout}.
GET /_ilm/status Get the ILM status · Get the ILM status #
Ask an LLM
“Is index lifecycle management currently running or stopped?”
“How do I check whether ILM is in the middle of stopping?”
Tell an agent
Get the ILM operating status.
Tell me whether index lifecycle management is running.
POST /_ilm/migrate_to_data_tiers Migrate indices and policies to data tiers · Migrate to data tiers routing #
Ask an LLM
“How do I switch from custom node attributes to data tier allocation?”
“Can I preview a data tiers migration before it changes anything?”
Tell an agent
Migrate to data tiers routing from node attribute {node_attribute}.
Dry-run the data tiers migration with dry_run {dry_run}.
POST /_ilm/move/{index} Manually move an index to a lifecycle step · Move to a lifecycle step #
Ask an LLM
“Can I force an index into a different ILM phase or step?”
“Is it risky to manually move an index to a lifecycle step?”
Tell an agent destructive · confirm first
Move {index} from step {current_step} to step {next_step}.
Force index {index} out of {current_step} and into lifecycle step {next_step}.
POST /{index}/_ilm/remove Remove lifecycle policies from an index · Remove policies from an index #
Ask an LLM
“How do I stop ILM from managing a particular index?”
“Can I detach the lifecycle policy from a data stream's backing indices?”
Tell an agent
Remove the lifecycle policy from {index}.
Stop ILM management of index {index}.
POST /{index}/_ilm/retry Retry a failed lifecycle step · Retry a policy #
Ask an LLM
“How do I retry an index that's stuck in the ILM ERROR step?”
“Can I rerun the lifecycle step that failed after fixing the cause?”
Tell an agent
Retry the lifecycle policy for {index}.
Rerun the failed ILM step on index {index}.
POST /_ilm/start Start index lifecycle management · Start the ILM plugin #
Ask an LLM
“How do I restart ILM after stopping it for maintenance?”
“Does ILM need to be started manually when a cluster forms?”
Tell an agent
Start the ILM plugin.
Resume index lifecycle management, waiting up to {timeout}.
POST /_ilm/stop Stop index lifecycle management · Stop the ILM plugin #
Ask an LLM
“How do I pause all ILM actions during cluster maintenance?”
“Will stopping ILM halt every lifecycle operation cluster-wide?”
Tell an agent
Stop the ILM plugin.
Halt all index lifecycle operations with master timeout {master_timeout}.

Documentation

📖
Documentation
https://www.elastic.co/docs/reference/elasticsearch
📖
APIReference
https://www.elastic.co/docs/api/doc/elasticsearch/
📖
Documentation
https://www.elastic.co/docs/reference/kibana
📖
APIReference
https://www.elastic.co/docs/api/doc/kibana/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-ilm-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/elastic/elasticsearch-specification
🔗
SourceCode
https://github.com/elastic/kibana
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/mcp/elk-stack-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/elk-stack:elk-stack-ilm-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

elk-stack-ilm-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Elasticsearch Request & Response Specification Ilm API
  license:
    name: Apache 2.0
    url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE
  version: ''
tags:


# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-ilm-api-openapi.yml