IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get lifecycle policy API
editGet lifecycle policy API
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Retrieves a lifecycle policy.
Description
editReturns the specified policy definition. Includes the policy version and last modified date. If no policy is specified, returns all defined policies.
Path Parameters
edit-
policy
(optional) - (string) Identifier for the policy.
Request Parameters
edit-
timeout
-
(time units) Specifies the period of time to wait for a response. If no
response is received before the timeout expires, the request fails and
returns an error. Defaults to
30s
. For more information about time units, see Time units. -
master_timeout
-
(time units) Specifies the period of time to wait for a connection to the
master node. If no response is received before the timeout expires, the request
fails and returns an error. Defaults to
30s
. For more information about time units, see Time units.
Authorization
editYou must have the manage_ilm
or read_ilm
or both cluster privileges to use this API.
For more information, see Security Privileges.
Examples
editThe following example retrieves my_policy
:
GET _ilm/policy
If the request succeeds, the body of the response contains the policy definition: