How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Stack (ELK Stack) Ilm API

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

Elastic Stack (ELK Stack) Ilm API is one of 132 APIs that Elastic Stack (ELK Stack) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ilm. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 12 operations across 10 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0.

Requests are made against the base URL https://{elasticsearch_endpoint}.

12 operations 10 paths 35 schemas 1 DELETE4 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://{elasticsearch_endpoint}
License
Resource Areas
1

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 1 DELETE, 4 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ilm 12
GET
/_ilm/policy/{policy}
Get lifecycle policies
ilm-get-lifecycle 3 params → 200
PUT
/_ilm/policy/{policy}
Create or update a lifecycle policy
ilm-put-lifecycle 3 params body → 200
DELETE
/_ilm/policy/{policy}
Delete a lifecycle policy
ilm-delete-lifecycle 3 params → 200
GET
/{index}/_ilm/explain
Explain the lifecycle state
ilm-explain-lifecycle 4 params → 200
GET
/_ilm/policy
Get lifecycle policies
ilm-get-lifecycle-1 2 params → 200
GET
/_ilm/status
Get the ILM status
ilm-get-status → 200
POST
/_ilm/migrate_to_data_tiers
Migrate to data tiers routing
ilm-migrate-to-data-tiers 2 params body → 200
POST
/_ilm/move/{index}
Move to a lifecycle step
ilm-move-to-step 1 param body → 200
POST
/{index}/_ilm/remove
Remove policies from an index
ilm-remove-policy 1 param → 200
POST
/{index}/_ilm/retry
Retry a policy
ilm-retry 1 param → 200
POST
/_ilm/start
Start the ILM plugin
ilm-start 2 params → 200
POST
/_ilm/stop
Stop the ILM plugin
ilm-stop 2 params → 200

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are ilm.explain_lifecycle.LifecycleExplainManaged (29 properties), ilm._types.Actions (13 properties), ilm._types.RolloverAction (10 properties), ilm._types.AllocateAction (5 properties). Each schema is shown below with its type and property counts.

ilm.explain_lifecycle.LifecycleExplainPhaseExecution
object
4 properties 3 required
_types.AcknowledgedResponseBase
object
1 property 1 required
_types.IndexName
string
ilm.explain_lifecycle.LifecycleExplainManaged
object
29 properties 3 required
ilm._types.DeleteAction
object
1 property
_types.Duration
A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indica…
ilm._types.Phases
object
5 properties
ilm._types.SearchableSnapshotAction
object
2 properties 1 required
ilm._types.Actions
object
13 properties
ilm.get_lifecycle.Lifecycle
object
3 properties 3 required
_types.UnitMillis
number
Time unit for milliseconds
_types.EpochTimeUnitMillis
ilm._types.MigrateAction
object
1 property
ilm._types.Policy
object
2 properties 1 required
_types.LifecycleOperationMode
string
_types.DurationValueUnitMillis
ilm._types.ForceMergeAction
object
2 properties 1 required
ilm._types.SetPriorityAction
object
1 property
_types.ByteSize
ilm._types.RolloverAction
object
10 properties
ilm._types.DownsampleAction
object
2 properties 1 required
ilm.explain_lifecycle.LifecycleExplainUnmanaged
object
2 properties 2 required
_types.Indices
_types.EmptyObject
object
For empty Class assignments
_types.DurationLarge
string
A date histogram interval. Similar to Duration with additional units: w (week), M (month), q (quarter) and y (year)
ilm._types.Phase
object
2 properties
ilm.move_to_step.StepKey
object
3 properties 1 required
_types.Metadata
object
_types.DateTime
A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch…
_types.VersionNumber
number
_types.Name
string
ilm._types.WaitForSnapshotAction
object
1 property 1 required
ilm.explain_lifecycle.LifecycleExplain
ilm._types.AllocateAction
object
5 properties
ilm._types.ShrinkAction
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-ilm-api-openapi.yml Raw ↑

Other APIs Elastic Stack (ELK Stack) publishes across the network.

Elastic Cloud API
Elastic Stack (ELK Stack) Accounts API
Elastic Stack (ELK Stack) Actions API
Elastic Stack (ELK Stack) agent builder API
Elastic Stack (ELK Stack) Alerting API
Elastic Stack (ELK Stack) Alerting V2 API
Elastic Stack (ELK Stack) Analytics API
Elastic Stack (ELK Stack) APM agent configuration API
Elastic Stack (ELK Stack) APM agent keys API
Elastic Stack (ELK Stack) APM annotations API
Elastic Stack (ELK Stack) APM server schema API
Elastic Stack (ELK Stack) APM sourcemaps API
Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) Ilm API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.