It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Search Deployments Migrate Elasticsearch resource to use ILM »

› › › ›

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.

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

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

Request example

edit

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

« Search Deployments Migrate Elasticsearch resource to use ILM »