IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« ClusterCredentials ClusterCurationSettings »

› › › ›

ClusterCrudResponse

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

`ClusterCrudResponse`

edit

The response to an Elasticsearch cluster or Kibana instance CRUD (create/update-plan) request.

Properties

edit

apm (ApmCrudResponse): If the endpoint is called with URL param 'validate_only=true', then this contains advanced debug info (the internal plan representation) for the APM that was created along with the submitted ES plan.
apm_id (string): For an operation creating or updating an APM, the Id of that cluster
cloud_id (string): An encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana
credentials (ClusterCredentials): The username and password for the new Elasticsearch cluster, which is returned from the Elasticsearch cluster create command.
diagnostics (object): If the endpoint is called with URL param 'validate_only=true', then this contains advanced debug info (the internal plan representation)
elasticsearch_cluster_id (string): For an operation creating or updating an Elasticsearch cluster, the Id of that cluster
kibana (ClusterCrudResponse): If the endpoint is called with URL param 'validate_only=true', then this contains advanced debug info (the internal plan representation) for the Kibana that was created along with the submitted ES plan.
kibana_cluster_id (string): For an operation creating or updating a Kibana cluster, the Id of that cluster

Example

edit

{
   "apm" : {
      "apm_id" : "string",
      "diagnostics" : {},
      "secret_token" : "string"
   },
   "apm_id" : "string",
   "cloud_id" : "string",
   "credentials" : {
      "password" : "string",
      "username" : "string"
   },
   "diagnostics" : {},
   "elasticsearch_cluster_id" : "string",
   "kibana" : null,
   "kibana_cluster_id" : "string"
}

« ClusterCredentials ClusterCurationSettings »