Migrate Elasticsearch and associated Kibana resources to enable CCR

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

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

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

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

Default value is false.

Responses

200

Standard response
Hide response attribute Show response attribute object
- warnings array[object]
  
  List of warnings generated from validating command
  
  Hide warnings attributes Show warnings attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string
  
  A human readable message describing the warning that occurred
404
- 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)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Values are deployments.deployment_not_found or deployments.deployment_resource_not_found.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields

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

curl \
 -X POST https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr

Response examples (200)

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

Response examples (404)

# Headers
x-cloud-error-codes: deployments.deployment_not_found

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