Migrate Elasticsearch and associated Kibana resources to enable CCR

edit

Migrate Elasticsearch and associated Kibana resources to enable CCR

edit

Migrates the specified Elasticsearch resource and its associated Kibana to enable CCR (if supported).

Request

edit

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

Path parameters

edit
Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment.

ref_id

string

Y

User-specified RefId for the Resource (or '_main' if there is only one).

Query parameters

edit
Name Type Required Description

validate_only

boolean; default: false

N

When true, will not enable CCR but returns warnings if any elements may lose availability during CCR enablement

Responses

edit
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

Request example

edit
curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr \
-H "Authorization: ApiKey $ECE_API_KEY"