Migrate Elasticsearch resource to use ILMedit

Migrates the specified Elasticsearch resource to use ILM.

Requestedit

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

Path parametersedit

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment.

ref_id

string

Y

User-specified RefId for the Resource.

Query parametersedit

Name Type Required Description

validate_only

boolean; default: false

N

When true, does not enable ILM but returns warnings if any applications may lose availability during ILM migration.

Request bodyedit

(EnableIlmRequest) (required) Information to build the ILM policies that will be created

Responsesedit

200

(DeploymentResourceCommandResponse) Standard response

404

(BasicFailedReply) * 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)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found, deployments.deployment_resource_not_found])
The error codes associated with the response
449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response
500

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

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_no_longer_exists])
The error codes associated with the response

Request exampleedit

curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "index_patterns" : [
      {
         "index_pattern" : "string",
         "node_attributes" : {
            "some_property" : "string"
         },
         "policy_name" : "string"
      }
   ]
}
'