Migrate Elasticsearch resource to use ILM

POST /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm

Auth

Migrates the specified Elasticsearch resource to use ILM.

Path parameters

deployment_id string required: Identifier for the Deployment.
ref_id string required: User-specified RefId for the Resource (or '_main' if there is only one).

Query parameters

validate_only boolean · default: false: When true, does not enable ILM but returns warnings if any applications may lose availability during ILM migration.

Request body

Information to build the ILM policies that will be created

index_patterns object[] required: A locally-unique user-specified id for Kibana

Responses

Standard response

application/json

warnings object[]: List of warnings generated from validating command

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)

application/json

We have failed you. (code: deployments.deployment_resource_no_longer_exists)

application/json

View as Markdown

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "${API_URL}/deployments/${DEPLOYMENT_ID}/elasticsearch/${REF_ID}/_enable-ilm" \
  -u "${USERNAME}:${PASSWORD}" \
  -H "Content-Type: application/json" \
  -d '{
    "index_patterns": [
      {
        "index_pattern": "string",
        "policy_name": "string"
      }
    ]
  }'

Generated from the API spec

Response

{
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec