Definitions

AllocatorMoveRequest

As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators.

Properties

allocator_down (boolean)
Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
from (string, required)
The allocator id off which all instances in the cluster should be moved
to (array[string])
An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

Example

{
   "allocator_down" : true,
   "from" : "string",
   "to" : [
      "string"
   ]
}

Apm

Holds diagnostics for an APM resource

Properties

backend_plan (object, required)
The backend plan as JSON
display_name (string, required)
The human readable name (defaults to the generated cluster id if not specified)
elasticsearch_cluster_ref_id (string, required)
The user-specified id of the Elasticsearch Cluster that this will link to
ref_id (string, required)
A locally-unique user-specified id

Example

{
   "backend_plan" : {},
   "display_name" : "string",
   "elasticsearch_cluster_ref_id" : "string",
   "ref_id" : "string"
}

ApmConfiguration

The configuration options for the APM Server.

Properties

docker_image (string)
A docker URI that allows overriding of the default docker image specified for this version
system_settings (ApmSystemSettings)
A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.
user_settings_json (object)
An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
user_settings_override_json (object)
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
user_settings_override_yaml (string)
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
user_settings_yaml (string)
An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
version (string)
The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)

Example

{
   "docker_image" : "string",
   "system_settings" : {
      "debug_enabled" : true,
      "elasticsearch_password" : "string",
      "elasticsearch_url" : "string",
      "elasticsearch_username" : "string",
      "kibana_url" : "string",
      "secret_token" : "string"
   },
   "user_settings_json" : {},
   "user_settings_override_json" : {},
   "user_settings_override_yaml" : "string",
   "user_settings_yaml" : "string",
   "version" : "string"
}

ApmInfo

The overview information for the APM Server.

Properties

deployment_id (string)
The id of the deployment that this APM Server belongs to.
elasticsearch_cluster (TargetElasticsearchCluster, required)
Information about the specified Elasticsearch cluster.
external_links (array[ExternalHyperlink], required)
External resources related to the APM
healthy (boolean, required)
Whether the APM is healthy or not (one or more of the info subsections will have healthy: false)
id (string, required)
The id of the APM
links (map[string,Hyperlink])
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
metadata (ClusterMetadataInfo)
Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.
name (string, required)
The name of the APM
plan_info (ApmPlansInfo, required)
Information about current, pending, and past APM Server plans.
region (string)
The region that this APM belongs to. Only populated in SaaS or federated ECE.
settings (ApmSettings)
The cluster metadata settings for the APM
status (string; allowed values: [initializing, stopping, stopped, rebooting, restarting, reconfiguring, started], required)
APM status
topology (ClusterTopologyInfo, required)
The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.

Example

{
   "deployment_id" : "string",
   "elasticsearch_cluster" : {
      "elasticsearch_id" : "string",
      "links" : {
         "some_property" : {
            "need_elevated_permissions" : true
         }
      }
   },
   "external_links" : [
      {
         "id" : "string",
         "label" : "string",
         "uri" : "string"
      }
   ],
   "healthy" : true,
   "id" : "string",
   "links" : {
      "some_property" : null
   },
   "metadata" : {
      "cloud_id" : "string",
      "endpoint" : "string",
      "last_modified" : "2019-01-01T00:00:00Z",
      "ports" : {
         "http" : 0,
         "https" : 0
      },
      "raw" : {},
      "version" : 0
   },
   "name" : "string",
   "plan_info" : {
      "current" : {
         "attempt_end_time" : "2019-01-01T00:00:00Z",
         "attempt_start_time" : "2019-01-01T00:00:00Z",
         "healthy" : true,
         "plan" : {
            "apm" : {
               "docker_image" : "string",
               "system_settings" : {
                  "debug_enabled" : true,
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string",
                  "kibana_url" : "string",
                  "secret_token" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "cluster_topology" : [
               {
                  "apm" : null,
                  "instance_configuration_id" : "string",
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "timeout" : 0
               },
               "strategy" : {
                  "autodetect" : {},
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         },
         "plan_attempt_id" : "string",
         "plan_attempt_log" : [
            {
               "completed" : "2019-01-01T00:00:00Z",
               "duration_in_millis" : 0,
               "info_log" : [
                  {
                     "delta_in_millis" : 0,
                     "message" : "string",
                     "stage" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z"
                  }
               ],
               "stage" : "string",
               "started" : "2019-01-01T00:00:00Z",
               "status" : "string",
               "step_id" : "string"
            }
         ],
         "plan_attempt_name" : "string",
         "plan_end_time" : "2019-01-01T00:00:00Z",
         "source" : {
            "action" : "string",
            "admin_id" : "string",
            "date" : "2019-01-01T00:00:00Z",
            "facilitator" : "string",
            "remote_addresses" : [
               "string"
            ],
            "user_id" : "string"
         }
      },
      "healthy" : true,
      "history" : [
         null
      ],
      "pending" : null
   },
   "region" : "string",
   "settings" : {
      "metadata" : {
         "name" : "string"
      }
   },
   "status" : "string",
   "topology" : {
      "healthy" : true,
      "instances" : [
         {
            "allocator_id" : "string",
            "container_started" : true,
            "disk" : {
               "disk_space_available" : 0,
               "disk_space_used" : 0,
               "storage_multiplier" : 0.1
            },
            "healthy" : true,
            "instance_configuration" : {
               "id" : "string",
               "name" : "string",
               "resource" : "string"
            },
            "instance_name" : "string",
            "maintenance_mode" : true,
            "memory" : {
               "instance_capacity" : 0,
               "instance_capacity_planned" : 0,
               "memory_pressure" : 0,
               "native_memory_pressure" : 0
            },
            "service_id" : "string",
            "service_roles" : [
               "string"
            ],
            "service_running" : true,
            "service_version" : "string",
            "zone" : "string"
         }
      ]
   }
}

ApmPayload

An APM creation request paired with the alias of the Elasticsearch cluster it should be paired with

Properties

display_name (string)
The human readable name for the APM cluster (default: takes the name of its Elasticsearch cluster)
elasticsearch_cluster_ref_id (string, required)
Alias to the Elasticsearch Cluster to attach APM to
plan (ApmPlan, required)
The plan for the APM Server.
ref_id (string, required)
A locally-unique user-specified id for APM
region (string, required)
The region where this resource exists
settings (ApmSettings)
The settings for building this APM cluster

Example

{
   "display_name" : "string",
   "elasticsearch_cluster_ref_id" : "string",
   "plan" : {
      "apm" : {
         "docker_image" : "string",
         "system_settings" : {
            "debug_enabled" : true,
            "elasticsearch_password" : "string",
            "elasticsearch_url" : "string",
            "elasticsearch_username" : "string",
            "kibana_url" : "string",
            "secret_token" : "string"
         },
         "user_settings_json" : {},
         "user_settings_override_json" : {},
         "user_settings_override_yaml" : "string",
         "user_settings_yaml" : "string",
         "version" : "string"
      },
      "cluster_topology" : [
         {
            "apm" : null,
            "instance_configuration_id" : "string",
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "transient" : {
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "timeout" : 0
         },
         "strategy" : {
            "autodetect" : {},
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   },
   "ref_id" : "string",
   "region" : "string",
   "settings" : {
      "metadata" : {
         "name" : "string"
      }
   }
}

ApmPlan

The plan for the APM Server.

Properties

apm (ApmConfiguration, required)
The configuration options for the APM Server.
cluster_topology (array[ApmTopologyElement])
transient (TransientApmPlanConfiguration)
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.

Example

{
   "apm" : {
      "docker_image" : "string",
      "system_settings" : {
         "debug_enabled" : true,
         "elasticsearch_password" : "string",
         "elasticsearch_url" : "string",
         "elasticsearch_username" : "string",
         "kibana_url" : "string",
         "secret_token" : "string"
      },
      "user_settings_json" : {},
      "user_settings_override_json" : {},
      "user_settings_override_yaml" : "string",
      "user_settings_yaml" : "string",
      "version" : "string"
   },
   "cluster_topology" : [
      {
         "apm" : null,
         "instance_configuration_id" : "string",
         "size" : {
            "resource" : "string",
            "value" : 0
         },
         "zone_count" : 0
      }
   ],
   "transient" : {
      "plan_configuration" : {
         "calm_wait_time" : 0,
         "cluster_reboot" : "string",
         "extended_maintenance" : true,
         "timeout" : 0
      },
      "strategy" : {
         "autodetect" : {},
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   }
}

ApmPlanControlConfiguration

The plan control configuration options for the APM Server.

Properties

calm_wait_time (integer as int64)
This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
cluster_reboot (string; allowed values: [forced])
Set to 'forced' to force a reboot as part of the upgrade plan
extended_maintenance (boolean)
If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
timeout (integer as int64)
The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

Example

{
   "calm_wait_time" : 0,
   "cluster_reboot" : "string",
   "extended_maintenance" : true,
   "timeout" : 0
}

ApmPlanInfo

Information about the APM Server plan.

Properties

attempt_end_time (string as date-time)
If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
attempt_start_time (string as date-time)
When this plan attempt (ie to apply the plan to the APM) started (ISO format in UTC)
healthy (boolean, required)
Either the plan ended successfully, or is not yet completed (and no errors have occurred)
plan (ApmPlan)
The plan for the APM Server.
plan_attempt_id (string)
A UUID for each plan attempt
plan_attempt_log (array[ClusterPlanStepInfo], required)
plan_attempt_name (string)
A human readable name for each plan attempt, only populated when retrieving plan histories
plan_end_time (string as date-time)
If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
source (ChangeSourceInfo)
Information describing the source that facilitated the plans current state

Example

{
   "attempt_end_time" : "2019-01-01T00:00:00Z",
   "attempt_start_time" : "2019-01-01T00:00:00Z",
   "healthy" : true,
   "plan" : {
      "apm" : {
         "docker_image" : "string",
         "system_settings" : {
            "debug_enabled" : true,
            "elasticsearch_password" : "string",
            "elasticsearch_url" : "string",
            "elasticsearch_username" : "string",
            "kibana_url" : "string",
            "secret_token" : "string"
         },
         "user_settings_json" : {},
         "user_settings_override_json" : {},
         "user_settings_override_yaml" : "string",
         "user_settings_yaml" : "string",
         "version" : "string"
      },
      "cluster_topology" : [
         {
            "apm" : null,
            "instance_configuration_id" : "string",
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "transient" : {
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "timeout" : 0
         },
         "strategy" : {
            "autodetect" : {},
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   },
   "plan_attempt_id" : "string",
   "plan_attempt_log" : [
      {
         "completed" : "2019-01-01T00:00:00Z",
         "duration_in_millis" : 0,
         "info_log" : [
            {
               "delta_in_millis" : 0,
               "message" : "string",
               "stage" : "string",
               "timestamp" : "2019-01-01T00:00:00Z"
            }
         ],
         "stage" : "string",
         "started" : "2019-01-01T00:00:00Z",
         "status" : "string",
         "step_id" : "string"
      }
   ],
   "plan_attempt_name" : "string",
   "plan_end_time" : "2019-01-01T00:00:00Z",
   "source" : {
      "action" : "string",
      "admin_id" : "string",
      "date" : "2019-01-01T00:00:00Z",
      "facilitator" : "string",
      "remote_addresses" : [
         "string"
      ],
      "user_id" : "string"
   }
}

ApmPlansInfo

Information about current, pending, and past APM Server plans.

Properties

current (ApmPlanInfo)
Information about the APM Server plan.
healthy (boolean, required)
Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
history (array[ApmPlanInfo], required)
pending (ApmPlanInfo)
Information about the APM Server plan.

Example

{
   "current" : {
      "attempt_end_time" : "2019-01-01T00:00:00Z",
      "attempt_start_time" : "2019-01-01T00:00:00Z",
      "healthy" : true,
      "plan" : {
         "apm" : {
            "docker_image" : "string",
            "system_settings" : {
               "debug_enabled" : true,
               "elasticsearch_password" : "string",
               "elasticsearch_url" : "string",
               "elasticsearch_username" : "string",
               "kibana_url" : "string",
               "secret_token" : "string"
            },
            "user_settings_json" : {},
            "user_settings_override_json" : {},
            "user_settings_override_yaml" : "string",
            "user_settings_yaml" : "string",
            "version" : "string"
         },
         "cluster_topology" : [
            {
               "apm" : null,
               "instance_configuration_id" : "string",
               "size" : {
                  "resource" : "string",
                  "value" : 0
               },
               "zone_count" : 0
            }
         ],
         "transient" : {
            "plan_configuration" : {
               "calm_wait_time" : 0,
               "cluster_reboot" : "string",
               "extended_maintenance" : true,
               "timeout" : 0
            },
            "strategy" : {
               "autodetect" : {},
               "grow_and_shrink" : {},
               "rolling" : {
                  "allow_inline_resize" : true,
                  "group_by" : "string",
                  "shard_init_wait_time" : 0,
                  "skip_synced_flush" : true
               },
               "rolling_grow_and_shrink" : {}
            }
         }
      },
      "plan_attempt_id" : "string",
      "plan_attempt_log" : [
         {
            "completed" : "2019-01-01T00:00:00Z",
            "duration_in_millis" : 0,
            "info_log" : [
               {
                  "delta_in_millis" : 0,
                  "message" : "string",
                  "stage" : "string",
                  "timestamp" : "2019-01-01T00:00:00Z"
               }
            ],
            "stage" : "string",
            "started" : "2019-01-01T00:00:00Z",
            "status" : "string",
            "step_id" : "string"
         }
      ],
      "plan_attempt_name" : "string",
      "plan_end_time" : "2019-01-01T00:00:00Z",
      "source" : {
         "action" : "string",
         "admin_id" : "string",
         "date" : "2019-01-01T00:00:00Z",
         "facilitator" : "string",
         "remote_addresses" : [
            "string"
         ],
         "user_id" : "string"
      }
   },
   "healthy" : true,
   "history" : [
      null
   ],
   "pending" : null
}

ApmResourceInfo

Describes an APM resource belonging to a Deployment

Properties

elasticsearch_cluster_ref_id (string, required)
The Elasticsearch cluster that this resource depends on.
id (string, required)
The randomly-generated id of a Resource
info (ApmInfo, required)
Info for the resource.
ref_id (string, required)
The locally-unique user-specified id of a Resource
region (string, required)
The region where this resource exists

Example

{
   "elasticsearch_cluster_ref_id" : "string",
   "id" : "string",
   "info" : {
      "deployment_id" : "string",
      "elasticsearch_cluster" : {
         "elasticsearch_id" : "string",
         "links" : {
            "some_property" : {
               "need_elevated_permissions" : true
            }
         }
      },
      "external_links" : [
         {
            "id" : "string",
            "label" : "string",
            "uri" : "string"
         }
      ],
      "healthy" : true,
      "id" : "string",
      "links" : {
         "some_property" : null
      },
      "metadata" : {
         "cloud_id" : "string",
         "endpoint" : "string",
         "last_modified" : "2019-01-01T00:00:00Z",
         "ports" : {
            "http" : 0,
            "https" : 0
         },
         "raw" : {},
         "version" : 0
      },
      "name" : "string",
      "plan_info" : {
         "current" : {
            "attempt_end_time" : "2019-01-01T00:00:00Z",
            "attempt_start_time" : "2019-01-01T00:00:00Z",
            "healthy" : true,
            "plan" : {
               "apm" : {
                  "docker_image" : "string",
                  "system_settings" : {
                     "debug_enabled" : true,
                     "elasticsearch_password" : "string",
                     "elasticsearch_url" : "string",
                     "elasticsearch_username" : "string",
                     "kibana_url" : "string",
                     "secret_token" : "string"
                  },
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "cluster_topology" : [
                  {
                     "apm" : null,
                     "instance_configuration_id" : "string",
                     "size" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "zone_count" : 0
                  }
               ],
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "timeout" : 0
                  },
                  "strategy" : {
                     "autodetect" : {},
                     "grow_and_shrink" : {},
                     "rolling" : {
                        "allow_inline_resize" : true,
                        "group_by" : "string",
                        "shard_init_wait_time" : 0,
                        "skip_synced_flush" : true
                     },
                     "rolling_grow_and_shrink" : {}
                  }
               }
            },
            "plan_attempt_id" : "string",
            "plan_attempt_log" : [
               {
                  "completed" : "2019-01-01T00:00:00Z",
                  "duration_in_millis" : 0,
                  "info_log" : [
                     {
                        "delta_in_millis" : 0,
                        "message" : "string",
                        "stage" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     }
                  ],
                  "stage" : "string",
                  "started" : "2019-01-01T00:00:00Z",
                  "status" : "string",
                  "step_id" : "string"
               }
            ],
            "plan_attempt_name" : "string",
            "plan_end_time" : "2019-01-01T00:00:00Z",
            "source" : {
               "action" : "string",
               "admin_id" : "string",
               "date" : "2019-01-01T00:00:00Z",
               "facilitator" : "string",
               "remote_addresses" : [
                  "string"
               ],
               "user_id" : "string"
            }
         },
         "healthy" : true,
         "history" : [
            null
         ],
         "pending" : null
      },
      "region" : "string",
      "settings" : {
         "metadata" : {
            "name" : "string"
         }
      },
      "status" : "string",
      "topology" : {
         "healthy" : true,
         "instances" : [
            {
               "allocator_id" : "string",
               "container_started" : true,
               "disk" : {
                  "disk_space_available" : 0,
                  "disk_space_used" : 0,
                  "storage_multiplier" : 0.1
               },
               "healthy" : true,
               "instance_configuration" : {
                  "id" : "string",
                  "name" : "string",
                  "resource" : "string"
               },
               "instance_name" : "string",
               "maintenance_mode" : true,
               "memory" : {
                  "instance_capacity" : 0,
                  "instance_capacity_planned" : 0,
                  "memory_pressure" : 0,
                  "native_memory_pressure" : 0
               },
               "service_id" : "string",
               "service_roles" : [
                  "string"
               ],
               "service_running" : true,
               "service_version" : "string",
               "zone" : "string"
            }
         ]
      }
   },
   "ref_id" : "string",
   "region" : "string"
}

ApmSettings

The settings for the APM Server.

Properties

metadata (ClusterMetadataSettings)
The top-level configuration settings for the Elasticsearch cluster.

Example

{
   "metadata" : {
      "name" : "string"
   }
}

ApmSubInfo

Information about the APM Servers associated with the Elasticsearch cluster.

Properties

apm_id (string, required)
The APM cluster Id
enabled (boolean, required)
Whether the associated APM cluster is currently available
links (map[string,Hyperlink])
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

Example

{
   "apm_id" : "string",
   "enabled" : true,
   "links" : {
      "some_property" : {
         "need_elevated_permissions" : true
      }
   }
}

ApmSystemSettings

A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use ApmSystemSettings with user_settings_override_ and user_settings_.

Properties

debug_enabled (boolean)
Optionally enable debug mode for APM servers - defaults false
elasticsearch_password (string)
Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified)
elasticsearch_url (string)
Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
elasticsearch_username (string)
Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified)
kibana_url (string)
Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
secret_token (string)
Optionally override the secret token within APM - defaults to the previously existing secretToken

Example

{
   "debug_enabled" : true,
   "elasticsearch_password" : "string",
   "elasticsearch_url" : "string",
   "elasticsearch_username" : "string",
   "kibana_url" : "string",
   "secret_token" : "string"
}

ApmTopologyElement

Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes.

Properties

apm (ApmConfiguration)
The configuration options for the APM Server.
instance_configuration_id (string)
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
size (TopologySize)
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
zone_count (integer as int32)
number of zones in which nodes will be placed

Example

{
   "apm" : {
      "docker_image" : "string",
      "system_settings" : {
         "debug_enabled" : true,
         "elasticsearch_password" : "string",
         "elasticsearch_url" : "string",
         "elasticsearch_username" : "string",
         "kibana_url" : "string",
         "secret_token" : "string"
      },
      "user_settings_json" : {},
      "user_settings_override_json" : {},
      "user_settings_override_yaml" : "string",
      "user_settings_yaml" : "string",
      "version" : "string"
   },
   "instance_configuration_id" : "string",
   "size" : {
      "resource" : "string",
      "value" : 0
   },
   "zone_count" : 0
}

AppSearch

Holds diagnostics for an AppSearch resource

Properties

backend_plan (object, required)
The backend plan as JSON
display_name (string, required)
The human readable name (defaults to the generated cluster id if not specified)
elasticsearch_cluster_ref_id (string, required)
The user-specified id of the Elasticsearch Cluster that this will link to
ref_id (string, required)
A locally-unique user-specified id

Example

{
   "backend_plan" : {},
   "display_name" : "string",
   "elasticsearch_cluster_ref_id" : "string",
   "ref_id" : "string"
}

AppSearchConfiguration

Intentionally left blank

Properties

docker_image (string)
A docker URI that allows overriding of the default docker image specified for this version
system_settings (AppSearchSystemSettings)
This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override_' and 'user_settings_' defines the total set of AppSearch settings)
user_settings_json (object)
An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
user_settings_override_json (object)
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
user_settings_override_yaml (string)
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings)
user_settings_yaml (string)
An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
version (string)
The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

Example

{
   "docker_image" : "string",
   "system_settings" : {
      "elasticsearch_password" : "string",
      "elasticsearch_url" : "string",
      "elasticsearch_username" : "string",
      "secret_session_key" : "string"
   },
   "user_settings_json" : {},
   "user_settings_override_json" : {},
   "user_settings_override_yaml" : "string",
   "user_settings_yaml" : "string",
   "version" : "string"
}

AppSearchInfo

The overview information for the App Search Server.

Properties

deployment_id (string)
The id of the deployment that this App Search belongs to.
elasticsearch_cluster (TargetElasticsearchCluster, required)
Information about the specified Elasticsearch cluster.
external_links (array[ExternalHyperlink], required)
External resources related to the App Search
healthy (boolean, required)
Whether the App Search is healthy or not (one or more of the info subsections will have healthy: false)
id (string, required)
The id of the App Search
links (map[string,Hyperlink])
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
metadata (ClusterMetadataInfo)
Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.
name (string, required)
The name of the App Search
plan_info (AppSearchPlansInfo, required)
Information about current, pending, and past App Search Server plans.
region (string)
The region that this App Search belongs to. Only populated in SaaS or federated ECE.
settings (AppSearchSettings)
The cluster metadata settings for the App Search
status (string; allowed values: [initializing, stopping, stopped, rebooting, restarting, reconfiguring, started], required)
App Search status
topology (ClusterTopologyInfo, required)
The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.

Example

{
   "deployment_id" : "string",
   "elasticsearch_cluster" : {
      "elasticsearch_id" : "string",
      "links" : {
         "some_property" : {
            "need_elevated_permissions" : true
         }
      }
   },
   "external_links" : [
      {
         "id" : "string",
         "label" : "string",
         "uri" : "string"
      }
   ],
   "healthy" : true,
   "id" : "string",
   "links" : {
      "some_property" : null
   },
   "metadata" : {
      "cloud_id" : "string",
      "endpoint" : "string",
      "last_modified" : "2019-01-01T00:00:00Z",
      "ports" : {
         "http" : 0,
         "https" : 0
      },
      "raw" : {},
      "version" : 0
   },
   "name" : "string",
   "plan_info" : {
      "current" : {
         "attempt_end_time" : "2019-01-01T00:00:00Z",
         "attempt_start_time" : "2019-01-01T00:00:00Z",
         "healthy" : true,
         "plan" : {
            "appsearch" : {
               "docker_image" : "string",
               "system_settings" : {
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string",
                  "secret_session_key" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "cluster_topology" : [
               {
                  "appsearch" : null,
                  "instance_configuration_id" : "string",
                  "node_type" : {
                     "appserver" : true,
                     "worker" : true
                  },
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "move_allocators" : [
                     {
                        "allocator_down" : true,
                        "from" : "string",
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "move_instances" : [
                     {
                        "from" : "string",
                        "instance_down" : true,
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "timeout" : 0
               },
               "strategy" : {
                  "autodetect" : {},
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         },
         "plan_attempt_id" : "string",
         "plan_attempt_log" : [
            {
               "completed" : "2019-01-01T00:00:00Z",
               "duration_in_millis" : 0,
               "info_log" : [
                  {
                     "delta_in_millis" : 0,
                     "message" : "string",
                     "stage" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z"
                  }
               ],
               "stage" : "string",
               "started" : "2019-01-01T00:00:00Z",
               "status" : "string",
               "step_id" : "string"
            }
         ],
         "plan_attempt_name" : "string",
         "plan_end_time" : "2019-01-01T00:00:00Z",
         "source" : {
            "action" : "string",
            "admin_id" : "string",
            "date" : "2019-01-01T00:00:00Z",
            "facilitator" : "string",
            "remote_addresses" : [
               "string"
            ],
            "user_id" : "string"
         }
      },
      "healthy" : true,
      "history" : [
         null
      ],
      "pending" : null
   },
   "region" : "string",
   "settings" : {
      "metadata" : {
         "name" : "string"
      }
   },
   "status" : "string",
   "topology" : {
      "healthy" : true,
      "instances" : [
         {
            "allocator_id" : "string",
            "container_started" : true,
            "disk" : {
               "disk_space_available" : 0,
               "disk_space_used" : 0,
               "storage_multiplier" : 0.1
            },
            "healthy" : true,
            "instance_configuration" : {
               "id" : "string",
               "name" : "string",
               "resource" : "string"
            },
            "instance_name" : "string",
            "maintenance_mode" : true,
            "memory" : {
               "instance_capacity" : 0,
               "instance_capacity_planned" : 0,
               "memory_pressure" : 0,
               "native_memory_pressure" : 0
            },
            "service_id" : "string",
            "service_roles" : [
               "string"
            ],
            "service_running" : true,
            "service_version" : "string",
            "zone" : "string"
         }
      ]
   }
}

AppSearchNodeTypes

Node types to enable for an AppSearch instance

Properties

appserver (boolean, required)
Defines whether this instance should run as Application/API server
worker (boolean, required)
Defines whether this instance should run as background worker

Example

{
   "appserver" : true,
   "worker" : true
}

AppSearchPayload

An AppSearch creation request paired with the alias of the Elasticsearch cluster it should be paired with

Properties

display_name (string)
The human readable name for the AppSearch cluster (default: takes the name of its Elasticsearch cluster)
elasticsearch_cluster_ref_id (string, required)
Alias to the Elasticsearch Cluster to attach AppSearch to
plan (AppSearchPlan, required)
ref_id (string, required)
A locally-unique user-specified id for AppSearch
region (string, required)
The region where this resource exists
settings (AppSearchSettings)
The settings for building this AppSearch cluster

Example

{
   "display_name" : "string",
   "elasticsearch_cluster_ref_id" : "string",
   "plan" : {
      "appsearch" : {
         "docker_image" : "string",
         "system_settings" : {
            "elasticsearch_password" : "string",
            "elasticsearch_url" : "string",
            "elasticsearch_username" : "string",
            "secret_session_key" : "string"
         },
         "user_settings_json" : {},
         "user_settings_override_json" : {},
         "user_settings_override_yaml" : "string",
         "user_settings_yaml" : "string",
         "version" : "string"
      },
      "cluster_topology" : [
         {
            "appsearch" : null,
            "instance_configuration_id" : "string",
            "node_type" : {
               "appserver" : true,
               "worker" : true
            },
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "transient" : {
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "move_allocators" : [
               {
                  "allocator_down" : true,
                  "from" : "string",
                  "to" : [
                     "string"
                  ]
               }
            ],
            "move_instances" : [
               {
                  "from" : "string",
                  "instance_down" : true,
                  "to" : [
                     "string"
                  ]
               }
            ],
            "preferred_allocators" : [
               "string"
            ],
            "reallocate_instances" : true,
            "timeout" : 0
         },
         "strategy" : {
            "autodetect" : {},
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   },
   "ref_id" : "string",
   "region" : "string",
   "settings" : {
      "metadata" : {
         "name" : "string"
      }
   }
}

AppSearchPlan

Intentionally left blank

Properties

appsearch (AppSearchConfiguration, required)
cluster_topology (array[AppSearchTopologyElement])
transient (TransientAppSearchPlanConfiguration)
Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied

Example

{
   "appsearch" : {
      "docker_image" : "string",
      "system_settings" : {
         "elasticsearch_password" : "string",
         "elasticsearch_url" : "string",
         "elasticsearch_username" : "string",
         "secret_session_key" : "string"
      },
      "user_settings_json" : {},
      "user_settings_override_json" : {},
      "user_settings_override_yaml" : "string",
      "user_settings_yaml" : "string",
      "version" : "string"
   },
   "cluster_topology" : [
      {
         "appsearch" : null,
         "instance_configuration_id" : "string",
         "node_type" : {
            "appserver" : true,
            "worker" : true
         },
         "size" : {
            "resource" : "string",
            "value" : 0
         },
         "zone_count" : 0
      }
   ],
   "transient" : {
      "plan_configuration" : {
         "calm_wait_time" : 0,
         "cluster_reboot" : "string",
         "extended_maintenance" : true,
         "move_allocators" : [
            {
               "allocator_down" : true,
               "from" : "string",
               "to" : [
                  "string"
               ]
            }
         ],
         "move_instances" : [
            {
               "from" : "string",
               "instance_down" : true,
               "to" : [
                  "string"
               ]
            }
         ],
         "preferred_allocators" : [
            "string"
         ],
         "reallocate_instances" : true,
         "timeout" : 0
      },
      "strategy" : {
         "autodetect" : {},
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   }
}

AppSearchPlanControlConfiguration

Intentionally left blank

Properties

calm_wait_time (integer as int64)
This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
cluster_reboot (string; allowed values: [forced])
Set to 'forced' to force a reboot as part of the upgrade plan
extended_maintenance (boolean)
If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
move_allocators (array[AllocatorMoveRequest])
move_instances (array[InstanceMoveRequest])
preferred_allocators (array[string])
List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
reallocate_instances (boolean)
If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
timeout (integer as int64)
The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

Example

{
   "calm_wait_time" : 0,
   "cluster_reboot" : "string",
   "extended_maintenance" : true,
   "move_allocators" : [
      {
         "allocator_down" : true,
         "from" : "string",
         "to" : [
            "string"
         ]
      }
   ],
   "move_instances" : [
      {
         "from" : "string",
         "instance_down" : true,
         "to" : [
            "string"
         ]
      }
   ],
   "preferred_allocators" : [
      "string"
   ],
   "reallocate_instances" : true,
   "timeout" : 0
}

AppSearchPlanInfo

Information about the App Search Server plan.

Properties

attempt_end_time (string as date-time)
If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
attempt_start_time (string as date-time)
When this plan attempt (ie to apply the plan to the App Search) started (ISO format in UTC)
healthy (boolean, required)
Either the plan ended successfully, or is not yet completed (and no errors have occurred)
plan (AppSearchPlan)
plan_attempt_id (string)
A UUID for each plan attempt
plan_attempt_log (array[ClusterPlanStepInfo], required)
plan_attempt_name (string)
A human readable name for each plan attempt, only populated when retrieving plan histories
plan_end_time (string as date-time)
If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
source (ChangeSourceInfo)
Information describing the source that facilitated the plans current state

Example

{
   "attempt_end_time" : "2019-01-01T00:00:00Z",
   "attempt_start_time" : "2019-01-01T00:00:00Z",
   "healthy" : true,
   "plan" : {
      "appsearch" : {
         "docker_image" : "string",
         "system_settings" : {
            "elasticsearch_password" : "string",
            "elasticsearch_url" : "string",
            "elasticsearch_username" : "string",
            "secret_session_key" : "string"
         },
         "user_settings_json" : {},
         "user_settings_override_json" : {},
         "user_settings_override_yaml" : "string",
         "user_settings_yaml" : "string",
         "version" : "string"
      },
      "cluster_topology" : [
         {
            "appsearch" : null,
            "instance_configuration_id" : "string",
            "node_type" : {
               "appserver" : true,
               "worker" : true
            },
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "transient" : {
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "move_allocators" : [
               {
                  "allocator_down" : true,
                  "from" : "string",
                  "to" : [
                     "string"
                  ]
               }
            ],
            "move_instances" : [
               {
                  "from" : "string",
                  "instance_down" : true,
                  "to" : [
                     "string"
                  ]
               }
            ],
            "preferred_allocators" : [
               "string"
            ],
            "reallocate_instances" : true,
            "timeout" : 0
         },
         "strategy" : {
            "autodetect" : {},
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   },
   "plan_attempt_id" : "string",
   "plan_attempt_log" : [
      {
         "completed" : "2019-01-01T00:00:00Z",
         "duration_in_millis" : 0,
         "info_log" : [
            {
               "delta_in_millis" : 0,
               "message" : "string",
               "stage" : "string",
               "timestamp" : "2019-01-01T00:00:00Z"
            }
         ],
         "stage" : "string",
         "started" : "2019-01-01T00:00:00Z",
         "status" : "string",
         "step_id" : "string"
      }
   ],
   "plan_attempt_name" : "string",
   "plan_end_time" : "2019-01-01T00:00:00Z",
   "source" : {
      "action" : "string",
      "admin_id" : "string",
      "date" : "2019-01-01T00:00:00Z",
      "facilitator" : "string",
      "remote_addresses" : [
         "string"
      ],
      "user_id" : "string"
   }
}

AppSearchPlansInfo

Information about current, pending, and past App Search Server plans.

Properties

current (AppSearchPlanInfo)
Information about the App Search Server plan.
healthy (boolean, required)
Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
history (array[AppSearchPlanInfo], required)
pending (AppSearchPlanInfo)
Information about the App Search Server plan.

Example

{
   "current" : {
      "attempt_end_time" : "2019-01-01T00:00:00Z",
      "attempt_start_time" : "2019-01-01T00:00:00Z",
      "healthy" : true,
      "plan" : {
         "appsearch" : {
            "docker_image" : "string",
            "system_settings" : {
               "elasticsearch_password" : "string",
               "elasticsearch_url" : "string",
               "elasticsearch_username" : "string",
               "secret_session_key" : "string"
            },
            "user_settings_json" : {},
            "user_settings_override_json" : {},
            "user_settings_override_yaml" : "string",
            "user_settings_yaml" : "string",
            "version" : "string"
         },
         "cluster_topology" : [
            {
               "appsearch" : null,
               "instance_configuration_id" : "string",
               "node_type" : {
                  "appserver" : true,
                  "worker" : true
               },
               "size" : {
                  "resource" : "string",
                  "value" : 0
               },
               "zone_count" : 0
            }
         ],
         "transient" : {
            "plan_configuration" : {
               "calm_wait_time" : 0,
               "cluster_reboot" : "string",
               "extended_maintenance" : true,
               "move_allocators" : [
                  {
                     "allocator_down" : true,
                     "from" : "string",
                     "to" : [
                        "string"
                     ]
                  }
               ],
               "move_instances" : [
                  {
                     "from" : "string",
                     "instance_down" : true,
                     "to" : [
                        "string"
                     ]
                  }
               ],
               "preferred_allocators" : [
                  "string"
               ],
               "reallocate_instances" : true,
               "timeout" : 0
            },
            "strategy" : {
               "autodetect" : {},
               "grow_and_shrink" : {},
               "rolling" : {
                  "allow_inline_resize" : true,
                  "group_by" : "string",
                  "shard_init_wait_time" : 0,
                  "skip_synced_flush" : true
               },
               "rolling_grow_and_shrink" : {}
            }
         }
      },
      "plan_attempt_id" : "string",
      "plan_attempt_log" : [
         {
            "completed" : "2019-01-01T00:00:00Z",
            "duration_in_millis" : 0,
            "info_log" : [
               {
                  "delta_in_millis" : 0,
                  "message" : "string",
                  "stage" : "string",
                  "timestamp" : "2019-01-01T00:00:00Z"
               }
            ],
            "stage" : "string",
            "started" : "2019-01-01T00:00:00Z",
            "status" : "string",
            "step_id" : "string"
         }
      ],
      "plan_attempt_name" : "string",
      "plan_end_time" : "2019-01-01T00:00:00Z",
      "source" : {
         "action" : "string",
         "admin_id" : "string",
         "date" : "2019-01-01T00:00:00Z",
         "facilitator" : "string",
         "remote_addresses" : [
            "string"
         ],
         "user_id" : "string"
      }
   },
   "healthy" : true,
   "history" : [
      null
   ],
   "pending" : null
}

AppSearchResourceInfo

Describes an App Search resource belonging to a Deployment

Properties

elasticsearch_cluster_ref_id (string, required)
The Elasticsearch cluster that this resource depends on.
id (string, required)
The randomly-generated id of a Resource
info (AppSearchInfo, required)
Info for the resource.
ref_id (string, required)
The locally-unique user-specified id of a Resource
region (string, required)
The region where this resource exists

Example

{
   "elasticsearch_cluster_ref_id" : "string",
   "id" : "string",
   "info" : {
      "deployment_id" : "string",
      "elasticsearch_cluster" : {
         "elasticsearch_id" : "string",
         "links" : {
            "some_property" : {
               "need_elevated_permissions" : true
            }
         }
      },
      "external_links" : [
         {
            "id" : "string",
            "label" : "string",
            "uri" : "string"
         }
      ],
      "healthy" : true,
      "id" : "string",
      "links" : {
         "some_property" : null
      },
      "metadata" : {
         "cloud_id" : "string",
         "endpoint" : "string",
         "last_modified" : "2019-01-01T00:00:00Z",
         "ports" : {
            "http" : 0,
            "https" : 0
         },
         "raw" : {},
         "version" : 0
      },
      "name" : "string",
      "plan_info" : {
         "current" : {
            "attempt_end_time" : "2019-01-01T00:00:00Z",
            "attempt_start_time" : "2019-01-01T00:00:00Z",
            "healthy" : true,
            "plan" : {
               "appsearch" : {
                  "docker_image" : "string",
                  "system_settings" : {
                     "elasticsearch_password" : "string",
                     "elasticsearch_url" : "string",
                     "elasticsearch_username" : "string",
                     "secret_session_key" : "string"
                  },
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "cluster_topology" : [
                  {
                     "appsearch" : null,
                     "instance_configuration_id" : "string",
                     "node_type" : {
                        "appserver" : true,
                        "worker" : true
                     },
                     "size" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "zone_count" : 0
                  }
               ],
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "move_allocators" : [
                        {
                           "allocator_down" : true,
                           "from" : "string",
                           "to" : [
                              "string"
                           ]
                        }
                     ],
                     "move_instances" : [
                        {
                           "from" : "string",
                           "instance_down" : true,
                           "to" : [
                              "string"
                           ]
                        }
                     ],
                     "preferred_allocators" : [
                        "string"
                     ],
                     "reallocate_instances" : true,
                     "timeout" : 0
                  },
                  "strategy" : {
                     "autodetect" : {},
                     "grow_and_shrink" : {},
                     "rolling" : {
                        "allow_inline_resize" : true,
                        "group_by" : "string",
                        "shard_init_wait_time" : 0,
                        "skip_synced_flush" : true
                     },
                     "rolling_grow_and_shrink" : {}
                  }
               }
            },
            "plan_attempt_id" : "string",
            "plan_attempt_log" : [
               {
                  "completed" : "2019-01-01T00:00:00Z",
                  "duration_in_millis" : 0,
                  "info_log" : [
                     {
                        "delta_in_millis" : 0,
                        "message" : "string",
                        "stage" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     }
                  ],
                  "stage" : "string",
                  "started" : "2019-01-01T00:00:00Z",
                  "status" : "string",
                  "step_id" : "string"
               }
            ],
            "plan_attempt_name" : "string",
            "plan_end_time" : "2019-01-01T00:00:00Z",
            "source" : {
               "action" : "string",
               "admin_id" : "string",
               "date" : "2019-01-01T00:00:00Z",
               "facilitator" : "string",
               "remote_addresses" : [
                  "string"
               ],
               "user_id" : "string"
            }
         },
         "healthy" : true,
         "history" : [
            null
         ],
         "pending" : null
      },
      "region" : "string",
      "settings" : {
         "metadata" : {
            "name" : "string"
         }
      },
      "status" : "string",
      "topology" : {
         "healthy" : true,
         "instances" : [
            {
               "allocator_id" : "string",
               "container_started" : true,
               "disk" : {
                  "disk_space_available" : 0,
                  "disk_space_used" : 0,
                  "storage_multiplier" : 0.1
               },
               "healthy" : true,
               "instance_configuration" : {
                  "id" : "string",
                  "name" : "string",
                  "resource" : "string"
               },
               "instance_name" : "string",
               "maintenance_mode" : true,
               "memory" : {
                  "instance_capacity" : 0,
                  "instance_capacity_planned" : 0,
                  "memory_pressure" : 0,
                  "native_memory_pressure" : 0
               },
               "service_id" : "string",
               "service_roles" : [
                  "string"
               ],
               "service_running" : true,
               "service_version" : "string",
               "zone" : "string"
            }
         ]
      }
   },
   "ref_id" : "string",
   "region" : "string"
}

AppSearchSettings

The settings for the App Search.

Properties

metadata (ClusterMetadataSettings)
The top-level configuration settings for the Elasticsearch cluster.

Example

{
   "metadata" : {
      "name" : "string"
   }
}

AppSearchSubInfo

Information about the APM Servers associated with the Elasticsearch cluster.

Properties

app_search_id (string, required)
The App Search Id
enabled (boolean, required)
Whether the associated App Search is currently available
links (map[string,Hyperlink])
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

Example

{
   "app_search_id" : "string",
   "enabled" : true,
   "links" : {
      "some_property" : {
         "need_elevated_permissions" : true
      }
   }
}

AppSearchSystemSettings

This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override_' and 'user_settings_' defines the total set of AppSearch settings)

Properties

elasticsearch_password (string)
Optionally override the account within AppSearch - defaults to a system account that always exists (if specified, the username must also be specified)
elasticsearch_url (string)
Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
elasticsearch_username (string)
Optionally override the account within AppSearch - defaults to a system account that always exists (if specified, the password must also be specified)
secret_session_key (string)
Optionally override the secret session key within AppSearch - defaults to the previously existing secretSession

Example

{
   "elasticsearch_password" : "string",
   "elasticsearch_url" : "string",
   "elasticsearch_username" : "string",
   "secret_session_key" : "string"
}

AppSearchTopologyElement

Defines the topology of the AppSearch nodes (eg number/capacity of nodes, and where they can be allocated)

Properties

appsearch (AppSearchConfiguration)
instance_configuration_id (string)
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
node_type (AppSearchNodeTypes)
Defines the AppSearch node type
size (TopologySize)
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
zone_count (integer as int32)
number of zones in which nodes will be placed

Example

{
   "appsearch" : {
      "docker_image" : "string",
      "system_settings" : {
         "elasticsearch_password" : "string",
         "elasticsearch_url" : "string",
         "elasticsearch_username" : "string",
         "secret_session_key" : "string"
      },
      "user_settings_json" : {},
      "user_settings_override_json" : {},
      "user_settings_override_yaml" : "string",
      "user_settings_yaml" : "string",
      "version" : "string"
   },
   "instance_configuration_id" : "string",
   "node_type" : {
      "appserver" : true,
      "worker" : true
   },
   "size" : {
      "resource" : "string",
      "value" : 0
   },
   "zone_count" : 0
}

AutodetectStrategyConfig

A strategy that lets constructor choose the most optimal way to execute the plan.

Example

{}

BasicFailedReply

Intentionally left blank

Properties

errors (array[BasicFailedReplyElement], required)
A list of errors that occurred in the failing request

Example

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

BasicFailedReplyElement

Intentionally left blank

Properties

code (string, required)
A structured code representing the error type 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
message (string, required)
A human readable message describing the error that occurred

Example

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

BoolQuery

A query for documents that match boolean combinations of other queries.

Properties

filter (array[QueryContainer])
minimum_should_match (integer as int32)
The minimum number of optional should clauses to match.
must (array[QueryContainer])
must_not (array[QueryContainer])
should (array[QueryContainer])

Example

{
   "filter" : [
      {
         "bool" : null,
         "exists" : {
            "field" : "string"
         },
         "match" : {
            "some_property" : {
               "analyzer" : "string",
               "minimum_should_match" : 0,
               "operator" : "string",
               "query" : "string"
            }
         },
         "match_all" : {},
         "match_none" : {},
         "nested" : {
            "path" : "string",
            "query" : null,
            "score_mode" : "string"
         },
         "prefix" : {
            "some_property" : {
               "boost" : 0.1,
               "value" : "string"
            }
         },
         "query_string" : {
            "allow_leading_wildcard" : true,
            "analyzer" : "string",
            "default_field" : "string",
            "default_operator" : "string",
            "query" : "string"
         },
         "range" : {
            "some_property" : {
               "boost" : 0.1,
               "format" : "string",
               "gt" : {},
               "gte" : {},
               "lt" : {},
               "lte" : {},
               "time_zone" : "string"
            }
         },
         "term" : {
            "some_property" : {
               "value" : {}
            }
         }
      }
   ],
   "minimum_should_match" : 0,
   "must" : [
      null
   ],
   "must_not" : [
      null
   ],
   "should" : [
      null
   ]
}

ChangeSourceInfo

A container for information about the source of a change.

Properties

action (string, required)
The type of plan change that was initiated
admin_id (string)
The admin user that requested the change
date (string as date-time, required)
The time the change was initiated
facilitator (string, required)
The service where the change originated from
remote_addresses (array[string])
The host addresses of the user that originated the change
user_id (string)
The user that requested the change

Example

{
   "action" : "string",
   "admin_id" : "string",
   "date" : "2019-01-01T00:00:00Z",
   "facilitator" : "string",
   "remote_addresses" : [
      "string"
   ],
   "user_id" : "string"
}

ClusterCredentials

The username and password for the new Elasticsearch cluster, which is returned from the Elasticsearch cluster create command.

Properties

password (string, required)
The password of the newly created cluster
username (string, required)
The username of the newly created cluster

Example

{
   "password" : "string",
   "username" : "string"
}

ClusterCurationSettings

The index curation settings for an Elasticsearch cluster.

Properties

specs (array[ClusterCurationSpec], required)
Specifications for curation

Example

{
   "specs" : [
      {
         "index_pattern" : "string",
         "trigger_interval_seconds" : 0
      }
   ]
}

ClusterCurationSpec

Specifies the conditions to trigger an Elasticsearch cluster curation.

Properties

index_pattern (string, required)
Index matching pattern
trigger_interval_seconds (integer as int32, required)
Number of seconds after index creation to trigger this spec

Example

{
   "index_pattern" : "string",
   "trigger_interval_seconds" : 0
}

ClusterInstanceConfigurationInfo

Information about a configuration that creates a Kibana instance or APM Server.

Properties

id (string, required)
The id of the configuration used to create the instance
name (string, required)
The name of the configuration used to create the instance
resource (string; allowed values: [memory, storage], required)
The resource type of the instance configuration

Example

{
   "id" : "string",
   "name" : "string",
   "resource" : "string"
}

ClusterInstanceDiskInfo

Information about the use and storage capacity of a Kibana instance or APM Server.

Properties

disk_space_available (integer as int64)
If known, the amount of total disk space available to the container in MB
disk_space_used (integer as int64, required)
The amount of disk space being used by the service in MB
storage_multiplier (number as double, required)
The storage multiplier originally defined to calculate disk space.

Example

{
   "disk_space_available" : 0,
   "disk_space_used" : 0,
   "storage_multiplier" : 0.1
}

ClusterInstanceInfo

Information about each Kibana instance and APM Server in the Elasticsearch cluster.

Properties

allocator_id (string)
The id of the allocator on which this instance is running (if the container is started or starting)
container_started (boolean, required)
Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)
disk (ClusterInstanceDiskInfo)
Information about the use and storage capacity of a Kibana instance or APM Server.
healthy (boolean, required)
Whether the instance is healthy (ie started and running)
instance_configuration (ClusterInstanceConfigurationInfo)
Information about a configuration that creates a Kibana instance or APM Server.
instance_name (string, required)
Whether the instance is healthy (ie started and running)
maintenance_mode (boolean, required)
Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)
memory (ClusterInstanceMemoryInfo)
Information about the memory capacity and use of the Kibana instance or APM Server.
service_id (string)
The service-specific (eg Elasticsearch) id of the node, if available
service_roles (array[string])
List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml
service_running (boolean, required)
Whether the service launched inside the container -ie Elasticsearch- is actually running
service_version (string)
The version of the service that the instance is running (eg Elasticsearch or Kibana), if available
zone (string)
The zone in which this instance is being allocated

Example

{
   "allocator_id" : "string",
   "container_started" : true,
   "disk" : {
      "disk_space_available" : 0,
      "disk_space_used" : 0,
      "storage_multiplier" : 0.1
   },
   "healthy" : true,
   "instance_configuration" : {
      "id" : "string",
      "name" : "string",
      "resource" : "string"
   },
   "instance_name" : "string",
   "maintenance_mode" : true,
   "memory" : {
      "instance_capacity" : 0,
      "instance_capacity_planned" : 0,
      "memory_pressure" : 0,
      "native_memory_pressure" : 0
   },
   "service_id" : "string",
   "service_roles" : [
      "string"
   ],
   "service_running" : true,
   "service_version" : "string",
   "zone" : "string"
}

ClusterInstanceMemoryInfo

Information about the memory capacity and use of the Kibana instance or APM Server.

Properties

instance_capacity (integer as int32, required)
The memory capacity in MB of the instance
instance_capacity_planned (integer as int32)
The planned memory capacity in MB of the instance (only shown when an override is present)
memory_pressure (integer as int32)
The % memory pressure of the service if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)
native_memory_pressure (integer as int32)
The % native memory pressure of the service if available

Example

{
   "instance_capacity" : 0,
   "instance_capacity_planned" : 0,
   "memory_pressure" : 0,
   "native_memory_pressure" : 0
}

ClusterMetadataInfo

Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.

Properties

cloud_id (string)
The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana (only present if both exist)
endpoint (string)
The DNS name of the cluster endpoint, if available
last_modified (string as date-time, required)
The most recent time the cluster metadata was changed (ISO format in UTC)
ports (ClusterMetadataPortInfo)
The ports that allow communication with the cluster using various protocols.
raw (object)
An unstructured JSON representation of the public and internal state (can be filtered out via URL parameter). The contents and structure of the raw field can change at any time.
version (integer as int32, required)
The resource version number of the cluster metadata

Example

{
   "cloud_id" : "string",
   "endpoint" : "string",
   "last_modified" : "2019-01-01T00:00:00Z",
   "ports" : {
      "http" : 0,
      "https" : 0
   },
   "raw" : {},
   "version" : 0
}

ClusterMetadataPortInfo

Information about the ports that allow communication between the Elasticsearch cluster and various protocols.

Properties

http (integer as int32, required)
Port where the cluster listens for HTTP traffic
https (integer as int32, required)
Port where the cluster listens for HTTPS traffic

Example

{
   "http" : 0,
   "https" : 0
}

ClusterMetadataSettings

The top-level configuration settings for the Elasticsearch cluster.

Properties

name (string)
The display name of the cluster

Example

{
   "name" : "string"
}

ClusterPlanStepInfo

Information about a step in a plan.

Properties

completed (string as date-time)
When the step completed (ISO format in UTC)
duration_in_millis (integer as int64)
The duration of the step in MS
info_log (array[ClusterPlanStepLogMessageInfo], required)
Human readable summaries of the step, including messages for each stage of the step
stage (string; allowed values: [starting, completed, in_progress], required)
Current stage that the step is in
started (string as date-time, required)
When the step started (ISO format in UTC)
status (string; allowed values: [success, warning, error, pending], required)
The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
step_id (string, required)
ID of current step

Example

{
   "completed" : "2019-01-01T00:00:00Z",
   "duration_in_millis" : 0,
   "info_log" : [
      {
         "delta_in_millis" : 0,
         "message" : "string",
         "stage" : "string",
         "timestamp" : "2019-01-01T00:00:00Z"
      }
   ],
   "stage" : "string",
   "started" : "2019-01-01T00:00:00Z",
   "status" : "string",
   "step_id" : "string"
}

ClusterPlanStepLogMessageInfo

The log message from a specified stage of an executed step in a plan.

Properties

delta_in_millis (integer as int64)
Time in milliseconds since previous log message
message (string, required)
Human readable log message
stage (string; allowed values: [starting, completed, in_progress], required)
Stage that info log message takes place in
timestamp (string as date-time, required)
Timestamp marking on info log of step

Example

{
   "delta_in_millis" : 0,
   "message" : "string",
   "stage" : "string",
   "timestamp" : "2019-01-01T00:00:00Z"
}

ClusterSnapshotRetention

Information about the Elasticsearch cluster snapshot retention.

Properties

max_age (string)
Total retention period for all snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute)
snapshots (integer as int32)
Number of snapshots to retain

Example

{
   "max_age" : "string",
   "snapshots" : 0
}

ClusterSnapshotSettings

The snapshot configuration settings for an Elasticsearch cluster.

Properties

cron_expression (string)
Cron expression indicating when should snapshots be taken. This can be enabled only if SLM is enabled for the deployment and 'interval' is not present
interval (string)
Interval between snapshots, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 30 minutes
retention (ClusterSnapshotRetention)
Cluster snapshot retention information
slm (boolean)
When set to true, the deployment will have SLM enabled. Default value is true.

Example

{
   "cron_expression" : "string",
   "interval" : "string",
   "retention" : {
      "max_age" : "string",
      "snapshots" : 0
   },
   "slm" : true
}

ClusterSystemAlert

Information about a system alert on an Elasticsearch cluster.

Properties

alert_type (string; allowed values: [automatic_restart, heap_dump, unknown_event], required)
Type of system alert
exit_code (integer as int32)
The exit_code related to the event. Only applicable for alert_type: slain
instance_name (string, required)
Instance that caused the system alert
timestamp (string as date-time, required)
Timestamp marking the system alert
url (string)
The URL related to the event. Only applicable for alert_type: heap_dump

Example

{
   "alert_type" : "string",
   "exit_code" : 0,
   "instance_name" : "string",
   "timestamp" : "2019-01-01T00:00:00Z",
   "url" : "string"
}

ClusterTopologyInfo

The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.

Properties

healthy (boolean, required)
Whether the cluster topology is healthy (ie all instances are started and the services they run - ie elasticsearch - are available
instances (array[ClusterInstanceInfo], required)

Example

{
   "healthy" : true,
   "instances" : [
      {
         "allocator_id" : "string",
         "container_started" : true,
         "disk" : {
            "disk_space_available" : 0,
            "disk_space_used" : 0,
            "storage_multiplier" : 0.1
         },
         "healthy" : true,
         "instance_configuration" : {
            "id" : "string",
            "name" : "string",
            "resource" : "string"
         },
         "instance_name" : "string",
         "maintenance_mode" : true,
         "memory" : {
            "instance_capacity" : 0,
            "instance_capacity_planned" : 0,
            "memory_pressure" : 0,
            "native_memory_pressure" : 0
         },
         "service_id" : "string",
         "service_roles" : [
            "string"
         ],
         "service_running" : true,
         "service_version" : "string",
         "zone" : "string"
      }
   ]
}

Creates

Holds diagnostics for resources that will be created

Properties

apm (array[Apm])
Diagnostics for APMs
appsearch (array[AppSearch])
Diagnostics for AppSearches
elasticsearch (array[Elasticsearch])
Diagnostics for Elasticsearch clusters
enterprise_search (array[EnterpriseSearch])
Diagnostics for Enterprise Search resources
kibana (array[Kibana])
Diagnostics for Kibanas

Example

{
   "apm" : [
      {
         "backend_plan" : {},
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "ref_id" : "string"
      }
   ],
   "appsearch" : [
      {
         "backend_plan" : {},
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "ref_id" : "string"
      }
   ],
   "elasticsearch" : [
      {
         "backend_plan" : {},
         "display_name" : "string",
         "ref_id" : "string"
      }
   ],
   "enterprise_search" : [
      {
         "backend_plan" : {},
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "ref_id" : "string"
      }
   ],
   "kibana" : [
      {
         "backend_plan" : {},
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "ref_id" : "string"
      }
   ]
}

CrossClusterSearchInfo

The cross-cluster search settings and status for the Elasticsearch cluster.

Properties

healthy (boolean, required)
Flag signaling health issues when at least one remote has an incompatible version with this cluster
remote_clusters (array[RemoteClusterInfo], required)
The list of remote clusters this cluster can access using cross-cluster search

Example

{
   "healthy" : true,
   "remote_clusters" : [
      {
         "compatible" : true,
         "id" : "string",
         "version" : "string"
      }
   ]
}

CrossClusterSearchSettings

The configuration settings for the cross-cluster search.

Properties

remote_clusters (map[string,RemoteClusterRef], required)
Mapping of remote cluster references keyed by their respective aliases. Aliases must only contain letters, digits, dashes and underscores

Example

{
   "remote_clusters" : {
      "some_property" : {
         "cluster_id" : "string",
         "skip_unavailable" : true
      }
   }
}

DeploymentCreateRequest

A request for creating a new Deployment consisting of multiple clusters

Properties

name (string)
A name for the deployment; otherwise this will be the generated deployment id
resources (DeploymentCreateResources, required)
The Resources that will belong to this Deployment
settings (DeploymentCreateSettings)
Additional configuration for this Deployment

Example

{
   "name" : "string",
   "resources" : {
      "apm" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "plan" : {
               "apm" : {
                  "docker_image" : "string",
                  "system_settings" : {
                     "debug_enabled" : true,
                     "elasticsearch_password" : "string",
                     "elasticsearch_url" : "string",
                     "elasticsearch_username" : "string",
                     "kibana_url" : "string",
                     "secret_token" : "string"
                  },
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "cluster_topology" : [
                  {
                     "apm" : null,
                     "instance_configuration_id" : "string",
                     "size" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "zone_count" : 0
                  }
               ],
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "timeout" : 0
                  },
                  "strategy" : {
                     "autodetect" : {},
                     "grow_and_shrink" : {},
                     "rolling" : {
                        "allow_inline_resize" : true,
                        "group_by" : "string",
                        "shard_init_wait_time" : 0,
                        "skip_synced_flush" : true
                     },
                     "rolling_grow_and_shrink" : {}
                  }
               }
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "metadata" : {
                  "name" : "string"
               }
            }
         }
      ],
      "appsearch" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "plan" : {
               "appsearch" : {
                  "docker_image" : "string",
                  "system_settings" : {
                     "elasticsearch_password" : "string",
                     "elasticsearch_url" : "string",
                     "elasticsearch_username" : "string",
                     "secret_session_key" : "string"
                  },
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "cluster_topology" : [
                  {
                     "appsearch" : null,
                     "instance_configuration_id" : "string",
                     "node_type" : {
                        "appserver" : true,
                        "worker" : true
                     },
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "move_allocators" : [
                        {
                           "allocator_down" : true,
                           "from" : "string",
                           "to" : [
                              "string"
                           ]
                        }
                     ],
                     "move_instances" : [
                        {
                           "from" : "string",
                           "instance_down" : true,
                           "to" : [
                              "string"
                           ]
                        }
                     ],
                     "preferred_allocators" : [
                        "string"
                     ],
                     "reallocate_instances" : true,
                     "timeout" : 0
                  },
                  "strategy" : null
               }
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "metadata" : null
            }
         }
      ],
      "elasticsearch" : [
         {
            "display_name" : "string",
            "plan" : {
               "cluster_topology" : [
                  {
                     "elasticsearch" : {
                        "curation" : {
                           "from_instance_configuration_id" : "string",
                           "to_instance_configuration_id" : "string"
                        },
                        "docker_image" : "string",
                        "enabled_built_in_plugins" : [
                           "string"
                        ],
                        "node_attributes" : {
                           "some_property" : "string"
                        },
                        "system_settings" : {
                           "auto_create_index" : true,
                           "default_shards_per_index" : 0,
                           "destructive_requires_name" : true,
                           "enable_close_index" : true,
                           "monitoring_collection_interval" : 0,
                           "monitoring_history_duration" : "string",
                           "reindex_whitelist" : [
                              "string"
                           ],
                           "scripting" : {
                              "expressions_enabled" : true,
                              "file" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              },
                              "inline" : null,
                              "mustache_enabled" : true,
                              "painless_enabled" : true,
                              "stored" : null
                           },
                           "use_disk_threshold" : true,
                           "watcher_trigger_engine" : "string"
                        },
                        "user_bundles" : [
                           {
                              "elasticsearch_version" : "string",
                              "name" : "string",
                              "url" : "string"
                           }
                        ],
                        "user_plugins" : [
                           {
                              "elasticsearch_version" : "string",
                              "name" : "string",
                              "url" : "string"
                           }
                        ],
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "instance_configuration_id" : "string",
                     "node_type" : {
                        "data" : true,
                        "ingest" : true,
                        "master" : true,
                        "ml" : true
                     },
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "deployment_template" : {
                  "id" : "string",
                  "version" : "string"
               },
               "elasticsearch" : null,
               "transient" : {
                  "cluster_settings_json" : {},
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "max_snapshot_age" : 0,
                     "max_snapshot_attempts" : 0,
                     "skip_snapshot" : true,
                     "timeout" : 0
                  },
                  "restore_snapshot" : {
                     "repository_config" : {
                        "raw_settings" : {}
                     },
                     "repository_name" : "string",
                     "restore_payload" : {
                        "indices" : [
                           "string"
                        ],
                        "raw_settings" : {}
                     },
                     "snapshot_name" : "string",
                     "source_cluster_id" : "string",
                     "strategy" : "string"
                  },
                  "strategy" : null
               }
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "ccs" : {
                  "remote_clusters" : {
                     "some_property" : {
                        "cluster_id" : "string",
                        "skip_unavailable" : true
                     }
                  }
               },
               "curation" : {
                  "specs" : [
                     {
                        "index_pattern" : "string",
                        "trigger_interval_seconds" : 0
                     }
                  ]
               },
               "dedicated_masters_threshold" : 0,
               "ip_filtering" : {
                  "rulesets" : [
                     "string"
                  ]
               },
               "metadata" : null,
               "monitoring" : {
                  "target_cluster_id" : "string"
               },
               "snapshot" : {
                  "cron_expression" : "string",
                  "interval" : "string",
                  "retention" : {
                     "max_age" : "string",
                     "snapshots" : 0
                  },
                  "slm" : true
               }
            }
         }
      ],
      "kibana" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "plan" : {
               "cluster_topology" : [
                  {
                     "instance_configuration_id" : "string",
                     "kibana" : {
                        "docker_image" : "string",
                        "system_settings" : {
                           "elasticsearch_password" : "string",
                           "elasticsearch_url" : "string",
                           "elasticsearch_username" : "string"
                        },
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "kibana" : null,
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "timeout" : 0
                  },
                  "strategy" : null
               }
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "metadata" : null
            }
         }
      ]
   },
   "settings" : {
      "ip_filtering_settings" : null
   }
}

DeploymentCreateResources

Describes the resources that will belong to a Deployment

Properties

apm (array[ApmPayload])
A list of payloads for APM creation.
appsearch (array[AppSearchPayload])
A list of payloads for AppSearch creation.
elasticsearch (array[ElasticsearchPayload])
A list of payloads for Elasticsearch cluster creation.
kibana (array[KibanaPayload])
A list of payloads for Kibana creation.

Example

{
   "apm" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "plan" : {
            "apm" : {
               "docker_image" : "string",
               "system_settings" : {
                  "debug_enabled" : true,
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string",
                  "kibana_url" : "string",
                  "secret_token" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "cluster_topology" : [
               {
                  "apm" : null,
                  "instance_configuration_id" : "string",
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "timeout" : 0
               },
               "strategy" : {
                  "autodetect" : {},
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "metadata" : {
               "name" : "string"
            }
         }
      }
   ],
   "appsearch" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "plan" : {
            "appsearch" : {
               "docker_image" : "string",
               "system_settings" : {
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string",
                  "secret_session_key" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "cluster_topology" : [
               {
                  "appsearch" : null,
                  "instance_configuration_id" : "string",
                  "node_type" : {
                     "appserver" : true,
                     "worker" : true
                  },
                  "size" : null,
                  "zone_count" : 0
               }
            ],
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "move_allocators" : [
                     {
                        "allocator_down" : true,
                        "from" : "string",
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "move_instances" : [
                     {
                        "from" : "string",
                        "instance_down" : true,
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "timeout" : 0
               },
               "strategy" : null
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "metadata" : null
         }
      }
   ],
   "elasticsearch" : [
      {
         "display_name" : "string",
         "plan" : {
            "cluster_topology" : [
               {
                  "elasticsearch" : {
                     "curation" : {
                        "from_instance_configuration_id" : "string",
                        "to_instance_configuration_id" : "string"
                     },
                     "docker_image" : "string",
                     "enabled_built_in_plugins" : [
                        "string"
                     ],
                     "node_attributes" : {
                        "some_property" : "string"
                     },
                     "system_settings" : {
                        "auto_create_index" : true,
                        "default_shards_per_index" : 0,
                        "destructive_requires_name" : true,
                        "enable_close_index" : true,
                        "monitoring_collection_interval" : 0,
                        "monitoring_history_duration" : "string",
                        "reindex_whitelist" : [
                           "string"
                        ],
                        "scripting" : {
                           "expressions_enabled" : true,
                           "file" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           },
                           "inline" : null,
                           "mustache_enabled" : true,
                           "painless_enabled" : true,
                           "stored" : null
                        },
                        "use_disk_threshold" : true,
                        "watcher_trigger_engine" : "string"
                     },
                     "user_bundles" : [
                        {
                           "elasticsearch_version" : "string",
                           "name" : "string",
                           "url" : "string"
                        }
                     ],
                     "user_plugins" : [
                        {
                           "elasticsearch_version" : "string",
                           "name" : "string",
                           "url" : "string"
                        }
                     ],
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "instance_configuration_id" : "string",
                  "node_type" : {
                     "data" : true,
                     "ingest" : true,
                     "master" : true,
                     "ml" : true
                  },
                  "size" : null,
                  "zone_count" : 0
               }
            ],
            "deployment_template" : {
               "id" : "string",
               "version" : "string"
            },
            "elasticsearch" : null,
            "transient" : {
               "cluster_settings_json" : {},
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "max_snapshot_age" : 0,
                  "max_snapshot_attempts" : 0,
                  "skip_snapshot" : true,
                  "timeout" : 0
               },
               "restore_snapshot" : {
                  "repository_config" : {
                     "raw_settings" : {}
                  },
                  "repository_name" : "string",
                  "restore_payload" : {
                     "indices" : [
                        "string"
                     ],
                     "raw_settings" : {}
                  },
                  "snapshot_name" : "string",
                  "source_cluster_id" : "string",
                  "strategy" : "string"
               },
               "strategy" : null
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "ccs" : {
               "remote_clusters" : {
                  "some_property" : {
                     "cluster_id" : "string",
                     "skip_unavailable" : true
                  }
               }
            },
            "curation" : {
               "specs" : [
                  {
                     "index_pattern" : "string",
                     "trigger_interval_seconds" : 0
                  }
               ]
            },
            "dedicated_masters_threshold" : 0,
            "ip_filtering" : {
               "rulesets" : [
                  "string"
               ]
            },
            "metadata" : null,
            "monitoring" : {
               "target_cluster_id" : "string"
            },
            "snapshot" : {
               "cron_expression" : "string",
               "interval" : "string",
               "retention" : {
                  "max_age" : "string",
                  "snapshots" : 0
               },
               "slm" : true
            }
         }
      }
   ],
   "kibana" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "plan" : {
            "cluster_topology" : [
               {
                  "instance_configuration_id" : "string",
                  "kibana" : {
                     "docker_image" : "string",
                     "system_settings" : {
                        "elasticsearch_password" : "string",
                        "elasticsearch_url" : "string",
                        "elasticsearch_username" : "string"
                     },
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "size" : null,
                  "zone_count" : 0
               }
            ],
            "kibana" : null,
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "timeout" : 0
               },
               "strategy" : null
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "metadata" : null
         }
      }
   ]
}

DeploymentCreateResponse

A response returned from the Deployment create endpoint

Properties

created (boolean, required)
Whether or not the deployment was freshly created
diagnostics (DeploymentDiagnostics)
Backend diagnostics. Sent if validation is requested.
id (string, required)
The id of the deployment
name (string, required)
The name of the deployment
resources (array[DeploymentResource], required)
List of created resources.

Example

{
   "created" : true,
   "diagnostics" : {
      "creates" : {
         "apm" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ],
         "appsearch" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ],
         "elasticsearch" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "ref_id" : "string"
            }
         ],
         "enterprise_search" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ],
         "kibana" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ]
      },
      "updates" : {
         "apm" : [
            null
         ],
         "appsearch" : [
            null
         ],
         "elasticsearch" : [
            null
         ],
         "enterprise_search" : [
            null
         ],
         "kibana" : [
            null
         ]
      }
   },
   "id" : "string",
   "name" : "string",
   "resources" : [
      {
         "cloud_id" : "string",
         "credentials" : {
            "password" : "string",
            "username" : "string"
         },
         "elasticsearch_cluster_ref_id" : "string",
         "id" : "string",
         "kind" : "string",
         "ref_id" : "string",
         "region" : "string",
         "secret_token" : "string"
      }
   ]
}

DeploymentCreateSettings

Additional configuration for the new deployment object.

Properties

ip_filtering_settings (IpFilteringSettings)
The set of rulesets applies to this deployment.

Example

{
   "ip_filtering_settings" : {
      "rulesets" : [
         "string"
      ]
   }
}

DeploymentDiagnostics

Describes the diagnostics for a given Deployment-modifying payload

Properties

creates (Creates)
Diagnostics for resources to be created
updates (Updates)
Diagnostics for existing resources that may be updated

Example

{
   "creates" : {
      "apm" : [
         {
            "backend_plan" : {},
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "ref_id" : "string"
         }
      ],
      "appsearch" : [
         {
            "backend_plan" : {},
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "ref_id" : "string"
         }
      ],
      "elasticsearch" : [
         {
            "backend_plan" : {},
            "display_name" : "string",
            "ref_id" : "string"
         }
      ],
      "enterprise_search" : [
         {
            "backend_plan" : {},
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "ref_id" : "string"
         }
      ],
      "kibana" : [
         {
            "backend_plan" : {},
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "ref_id" : "string"
         }
      ]
   },
   "updates" : {
      "apm" : [
         null
      ],
      "appsearch" : [
         null
      ],
      "elasticsearch" : [
         null
      ],
      "enterprise_search" : [
         null
      ],
      "kibana" : [
         null
      ]
   }
}

DeploymentGetResponse

Describes a given Deployment

Properties

healthy (boolean, required)
Whether the deployment is overall healthy or not (one or more of the resource info subsections will have healthy: false)
id (string, required)
A randomly-generated id of this Deployment
name (string, required)
The name of this deployment
resources (DeploymentResources, required)
The Resources that belong to this Deployment
settings (DeploymentSettings)
Additional configuration for this Deployment

Example

{
   "healthy" : true,
   "id" : "string",
   "name" : "string",
   "resources" : {
      "apm" : [
         {
            "elasticsearch_cluster_ref_id" : "string",
            "id" : "string",
            "info" : {
               "deployment_id" : "string",
               "elasticsearch_cluster" : {
                  "elasticsearch_id" : "string",
                  "links" : {
                     "some_property" : {
                        "need_elevated_permissions" : true
                     }
                  }
               },
               "external_links" : [
                  {
                     "id" : "string",
                     "label" : "string",
                     "uri" : "string"
                  }
               ],
               "healthy" : true,
               "id" : "string",
               "links" : {
                  "some_property" : null
               },
               "metadata" : {
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0
                  },
                  "raw" : {},
                  "version" : 0
               },
               "name" : "string",
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "healthy" : true,
                     "plan" : {
                        "apm" : {
                           "docker_image" : "string",
                           "system_settings" : {
                              "debug_enabled" : true,
                              "elasticsearch_password" : "string",
                              "elasticsearch_url" : "string",
                              "elasticsearch_username" : "string",
                              "kibana_url" : "string",
                              "secret_token" : "string"
                           },
                           "user_settings_json" : {},
                           "user_settings_override_json" : {},
                           "user_settings_override_yaml" : "string",
                           "user_settings_yaml" : "string",
                           "version" : "string"
                        },
                        "cluster_topology" : [
                           {
                              "apm" : null,
                              "instance_configuration_id" : "string",
                              "size" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "zone_count" : 0
                           }
                        ],
                        "transient" : {
                           "plan_configuration" : {
                              "calm_wait_time" : 0,
                              "cluster_reboot" : "string",
                              "extended_maintenance" : true,
                              "timeout" : 0
                           },
                           "strategy" : {
                              "autodetect" : {},
                              "grow_and_shrink" : {},
                              "rolling" : {
                                 "allow_inline_resize" : true,
                                 "group_by" : "string",
                                 "shard_init_wait_time" : 0,
                                 "skip_synced_flush" : true
                              },
                              "rolling_grow_and_shrink" : {}
                           }
                        }
                     },
                     "plan_attempt_id" : "string",
                     "plan_attempt_log" : [
                        {
                           "completed" : "2019-01-01T00:00:00Z",
                           "duration_in_millis" : 0,
                           "info_log" : [
                              {
                                 "delta_in_millis" : 0,
                                 "message" : "string",
                                 "stage" : "string",
                                 "timestamp" : "2019-01-01T00:00:00Z"
                              }
                           ],
                           "stage" : "string",
                           "started" : "2019-01-01T00:00:00Z",
                           "status" : "string",
                           "step_id" : "string"
                        }
                     ],
                     "plan_attempt_name" : "string",
                     "plan_end_time" : "2019-01-01T00:00:00Z",
                     "source" : {
                        "action" : "string",
                        "admin_id" : "string",
                        "date" : "2019-01-01T00:00:00Z",
                        "facilitator" : "string",
                        "remote_addresses" : [
                           "string"
                        ],
                        "user_id" : "string"
                     }
                  },
                  "healthy" : true,
                  "history" : [
                     null
                  ],
                  "pending" : null
               },
               "region" : "string",
               "settings" : {
                  "metadata" : {
                     "name" : "string"
                  }
               },
               "status" : "string",
               "topology" : {
                  "healthy" : true,
                  "instances" : [
                     {
                        "allocator_id" : "string",
                        "container_started" : true,
                        "disk" : {
                           "disk_space_available" : 0,
                           "disk_space_used" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "healthy" : true,
                        "instance_configuration" : {
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "service_id" : "string",
                        "service_roles" : [
                           "string"
                        ],
                        "service_running" : true,
                        "service_version" : "string",
                        "zone" : "string"
                     }
                  ]
               }
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ],
      "appsearch" : [
         {
            "elasticsearch_cluster_ref_id" : "string",
            "id" : "string",
            "info" : {
               "deployment_id" : "string",
               "elasticsearch_cluster" : null,
               "external_links" : [
                  null
               ],
               "healthy" : true,
               "id" : "string",
               "links" : {
                  "some_property" : null
               },
               "metadata" : null,
               "name" : "string",
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "healthy" : true,
                     "plan" : {
                        "appsearch" : {
                           "docker_image" : "string",
                           "system_settings" : {
                              "elasticsearch_password" : "string",
                              "elasticsearch_url" : "string",
                              "elasticsearch_username" : "string",
                              "secret_session_key" : "string"
                           },
                           "user_settings_json" : {},
                           "user_settings_override_json" : {},
                           "user_settings_override_yaml" : "string",
                           "user_settings_yaml" : "string",
                           "version" : "string"
                        },
                        "cluster_topology" : [
                           {
                              "appsearch" : null,
                              "instance_configuration_id" : "string",
                              "node_type" : {
                                 "appserver" : true,
                                 "worker" : true
                              },
                              "size" : null,
                              "zone_count" : 0
                           }
                        ],
                        "transient" : {
                           "plan_configuration" : {
                              "calm_wait_time" : 0,
                              "cluster_reboot" : "string",
                              "extended_maintenance" : true,
                              "move_allocators" : [
                                 {
                                    "allocator_down" : true,
                                    "from" : "string",
                                    "to" : [
                                       "string"
                                    ]
                                 }
                              ],
                              "move_instances" : [
                                 {
                                    "from" : "string",
                                    "instance_down" : true,
                                    "to" : [
                                       "string"
                                    ]
                                 }
                              ],
                              "preferred_allocators" : [
                                 "string"
                              ],
                              "reallocate_instances" : true,
                              "timeout" : 0
                           },
                           "strategy" : null
                        }
                     },
                     "plan_attempt_id" : "string",
                     "plan_attempt_log" : [
                        null
                     ],
                     "plan_attempt_name" : "string",
                     "plan_end_time" : "2019-01-01T00:00:00Z",
                     "source" : null
                  },
                  "healthy" : true,
                  "history" : [
                     null
                  ],
                  "pending" : null
               },
               "region" : "string",
               "settings" : {
                  "metadata" : null
               },
               "status" : "string",
               "topology" : null
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ],
      "elasticsearch" : [
         {
            "id" : "string",
            "info" : {
               "associated_apm_clusters" : [
                  {
                     "apm_id" : "string",
                     "enabled" : true,
                     "links" : {
                        "some_property" : null
                     }
                  }
               ],
               "associated_appsearch_clusters" : [
                  {
                     "app_search_id" : "string",
                     "enabled" : true,
                     "links" : {
                        "some_property" : null
                     }
                  }
               ],
               "associated_enterprise_search_clusters" : [
                  {
                     "enabled" : true,
                     "enterprise_search_id" : "string",
                     "links" : {
                        "some_property" : null
                     }
                  }
               ],
               "associated_kibana_clusters" : [
                  {
                     "enabled" : true,
                     "kibana_id" : "string",
                     "links" : {
                        "some_property" : null
                     }
                  }
               ],
               "ccs" : {
                  "healthy" : true,
                  "remote_clusters" : [
                     {
                        "compatible" : true,
                        "id" : "string",
                        "version" : "string"
                     }
                  ]
               },
               "cluster_id" : "string",
               "cluster_name" : "string",
               "deployment_id" : "string",
               "elasticsearch" : {
                  "blocking_issues" : {
                     "cluster_level" : [
                        {
                           "description" : "string",
                           "instances" : [
                              "string"
                           ]
                        }
                     ],
                     "healthy" : true,
                     "index_level" : [
                        null
                     ]
                  },
                  "healthy" : true,
                  "master_info" : {
                     "healthy" : true,
                     "instances_with_no_master" : [
                        "string"
                     ],
                     "masters" : [
                        {
                           "instances" : [
                              "string"
                           ],
                           "master_instance_name" : "string",
                           "master_node_id" : "string"
                        }
                     ]
                  },
                  "shard_info" : {
                     "available_shards" : [
                        {
                           "instance_name" : "string",
                           "shard_count" : 0
                        }
                     ],
                     "healthy" : true,
                     "unavailable_replicas" : [
                        {
                           "instance_name" : "string",
                           "replica_count" : 0
                        }
                     ],
                     "unavailable_shards" : [
                        null
                     ]
                  }
               },
               "elasticsearch_monitoring_info" : {
                  "destination_cluster_ids" : [
                     "string"
                  ],
                  "healthy" : true,
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "last_update_status" : "string",
                  "source_cluster_ids" : [
                     "string"
                  ]
               },
               "external_links" : [
                  null
               ],
               "healthy" : true,
               "links" : {
                  "some_property" : null
               },
               "metadata" : null,
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "elasticsearch" : {
                                 "curation" : {
                                    "from_instance_configuration_id" : "string",
                                    "to_instance_configuration_id" : "string"
                                 },
                                 "docker_image" : "string",
                                 "enabled_built_in_plugins" : [
                                    "string"
                                 ],
                                 "node_attributes" : {
                                    "some_property" : "string"
                                 },
                                 "system_settings" : {
                                    "auto_create_index" : true,
                                    "default_shards_per_index" : 0,
                                    "destructive_requires_name" : true,
                                    "enable_close_index" : true,
                                    "monitoring_collection_interval" : 0,
                                    "monitoring_history_duration" : "string",
                                    "reindex_whitelist" : [
                                       "string"
                                    ],
                                    "scripting" : {
                                       "expressions_enabled" : true,
                                       "file" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       },
                                       "inline" : null,
                                       "mustache_enabled" : true,
                                       "painless_enabled" : true,
                                       "stored" : null
                                    },
                                    "use_disk_threshold" : true,
                                    "watcher_trigger_engine" : "string"
                                 },
                                 "user_bundles" : [
                                    {
                                       "elasticsearch_version" : "string",
                                       "name" : "string",
                                       "url" : "string"
                                    }
                                 ],
                                 "user_plugins" : [
                                    {
                                       "elasticsearch_version" : "string",
                                       "name" : "string",
                                       "url" : "string"
                                    }
                                 ],
                                 "user_settings_json" : {},
                                 "user_settings_override_json" : {},
                                 "user_settings_override_yaml" : "string",
                                 "user_settings_yaml" : "string",
                                 "version" : "string"
                              },
                              "instance_configuration_id" : "string",
                              "node_type" : {
                                 "data" : true,
                                 "ingest" : true,
                                 "master" : true,
                                 "ml" : true
                              },
                              "size" : null,
                              "zone_count" : 0
                           }
                        ],
                        "deployment_template" : {
                           "id" : "string",
                           "version" : "string"
                        },
                        "elasticsearch" : null,
                        "transient" : {
                           "cluster_settings_json" : {},
                           "plan_configuration" : {
                              "calm_wait_time" : 0,
                              "cluster_reboot" : "string",
                              "extended_maintenance" : true,
                              "max_snapshot_age" : 0,
                              "max_snapshot_attempts" : 0,
                              "skip_snapshot" : true,
                              "timeout" : 0
                           },
                           "restore_snapshot" : {
                              "repository_config" : {
                                 "raw_settings" : {}
                              },
                              "repository_name" : "string",
                              "restore_payload" : {
                                 "indices" : [
                                    "string"
                                 ],
                                 "raw_settings" : {}
                              },
                              "snapshot_name" : "string",
                              "source_cluster_id" : "string",
                              "strategy" : "string"
                           },
                           "strategy" : null
                        }
                     },
                     "plan_attempt_id" : "string",
                     "plan_attempt_log" : [
                        null
                     ],
                     "plan_attempt_name" : "string",
                     "plan_end_time" : "2019-01-01T00:00:00Z",
                     "source" : null
                  },
                  "healthy" : true,
                  "history" : [
                     null
                  ],
                  "pending" : null
               },
               "region" : "string",
               "security" : {
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "roles" : {},
                  "users" : [
                     {
                        "password_hash" : "string",
                        "username" : "string"
                     }
                  ],
                  "users_roles" : [
                     {
                        "roles" : [
                           "string"
                        ],
                        "username" : "string"
                     }
                  ],
                  "version" : 0
               },
               "settings" : {
                  "ccs" : {
                     "remote_clusters" : {
                        "some_property" : {
                           "cluster_id" : "string",
                           "skip_unavailable" : true
                        }
                     }
                  },
                  "curation" : {
                     "specs" : [
                        {
                           "index_pattern" : "string",
                           "trigger_interval_seconds" : 0
                        }
                     ]
                  },
                  "dedicated_masters_threshold" : 0,
                  "ip_filtering" : {
                     "rulesets" : [
                        "string"
                     ]
                  },
                  "metadata" : null,
                  "monitoring" : {
                     "target_cluster_id" : "string"
                  },
                  "snapshot" : {
                     "cron_expression" : "string",
                     "interval" : "string",
                     "retention" : {
                        "max_age" : "string",
                        "snapshots" : 0
                     },
                     "slm" : true
                  }
               },
               "snapshots" : {
                  "count" : 0,
                  "healthy" : true,
                  "latest_end_time" : "2019-01-01T00:00:00Z",
                  "latest_status" : "string",
                  "latest_successful" : true,
                  "latest_successful_end_time" : "2019-01-01T00:00:00Z",
                  "recent_success" : true,
                  "scheduled_time" : "2019-01-01T00:00:00Z"
               },
               "status" : "string",
               "system_alerts" : [
                  {
                     "alert_type" : "string",
                     "exit_code" : 0,
                     "instance_name" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z",
                     "url" : "string"
                  }
               ],
               "topology" : null
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ],
      "enterprise_search" : [
         {
            "elasticsearch_cluster_ref_id" : "string",
            "id" : "string",
            "info" : {
               "deployment_id" : "string",
               "elasticsearch_cluster" : null,
               "external_links" : [
                  null
               ],
               "healthy" : true,
               "id" : "string",
               "links" : {
                  "some_property" : null
               },
               "metadata" : null,
               "name" : "string",
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "allocator_filter" : {},
                              "enterprise_search" : {
                                 "docker_image" : "string",
                                 "system_settings" : {
                                    "elasticsearch_password" : "string",
                                    "elasticsearch_url" : "string",
                                    "elasticsearch_username" : "string",
                                    "secret_session_key" : "string"
                                 },
                                 "user_settings_json" : {},
                                 "user_settings_override_json" : {},
                                 "user_settings_override_yaml" : "string",
                                 "user_settings_yaml" : "string",
                                 "version" : "string"
                              },
                              "instance_configuration_id" : "string",
                              "memory_per_node" : {},
                              "node_configuration" : "string",
                              "node_count_per_zone" : {},
                              "node_type" : {
                                 "appserver" : true,
                                 "connector" : true,
                                 "worker" : true
                              },
                              "size" : null,
                              "zone_count" : 0
                           }
                        ],
                        "enterprise_search" : null,
                        "transient" : {
                           "plan_configuration" : {
                              "calm_wait_time" : 0,
                              "cluster_reboot" : "string",
                              "extended_maintenance" : true,
                              "move_allocators" : [
                                 null
                              ],
                              "move_instances" : [
                                 null
                              ],
                              "preferred_allocators" : [
                                 "string"
                              ],
                              "reallocate_instances" : true,
                              "timeout" : 0
                           },
                           "strategy" : null
                        }
                     },
                     "plan_attempt_id" : "string",
                     "plan_attempt_log" : [
                        null
                     ],
                     "plan_attempt_name" : "string",
                     "plan_end_time" : "2019-01-01T00:00:00Z",
                     "source" : null
                  },
                  "healthy" : true,
                  "history" : [
                     null
                  ],
                  "pending" : null
               },
               "region" : "string",
               "settings" : {
                  "metadata" : null
               },
               "status" : "string",
               "topology" : null
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ],
      "kibana" : [
         {
            "elasticsearch_cluster_ref_id" : "string",
            "id" : "string",
            "info" : {
               "cluster_id" : "string",
               "cluster_name" : "string",
               "deployment_id" : "string",
               "elasticsearch_cluster" : null,
               "external_links" : [
                  null
               ],
               "healthy" : true,
               "links" : {
                  "some_property" : null
               },
               "metadata" : null,
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "instance_configuration_id" : "string",
                              "kibana" : {
                                 "docker_image" : "string",
                                 "system_settings" : {
                                    "elasticsearch_password" : "string",
                                    "elasticsearch_url" : "string",
                                    "elasticsearch_username" : "string"
                                 },
                                 "user_settings_json" : {},
                                 "user_settings_override_json" : {},
                                 "user_settings_override_yaml" : "string",
                                 "user_settings_yaml" : "string",
                                 "version" : "string"
                              },
                              "size" : null,
                              "zone_count" : 0
                           }
                        ],
                        "kibana" : null,
                        "transient" : {
                           "plan_configuration" : {
                              "calm_wait_time" : 0,
                              "cluster_reboot" : "string",
                              "extended_maintenance" : true,
                              "timeout" : 0
                           },
                           "strategy" : null
                        }
                     },
                     "plan_attempt_id" : "string",
                     "plan_attempt_log" : [
                        null
                     ],
                     "plan_attempt_name" : "string",
                     "plan_end_time" : "2019-01-01T00:00:00Z",
                     "source" : null
                  },
                  "healthy" : true,
                  "history" : [
                     null
                  ],
                  "pending" : null
               },
               "region" : "string",
               "settings" : {
                  "metadata" : null
               },
               "status" : "string",
               "topology" : null
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ]
   },
   "settings" : {
      "ip_filtering_settings" : null
   }
}

DeploymentResource

Data for a deployment resource

Properties

cloud_id (string)
An encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana
credentials (ClusterCredentials)
Credentials for logging into a created resource. Only provided on initial create and absent otherwise.
elasticsearch_cluster_ref_id (string)
The Elasticsearch cluster that this resource depends on.
id (string, required)
A system-unique id for the created resource
kind (string, required)
The kind of resource
ref_id (string, required)
A locally-unique friendly alias for this Elasticsearch cluster
region (string, required)
Identifier of the region in which this resource runs.
secret_token (string)
Secret token for using a created resource. Only provided on initial create and absent otherwise.

Example

{
   "cloud_id" : "string",
   "credentials" : {
      "password" : "string",
      "username" : "string"
   },
   "elasticsearch_cluster_ref_id" : "string",
   "id" : "string",
   "kind" : "string",
   "ref_id" : "string",
   "region" : "string",
   "secret_token" : "string"
}

DeploymentResourceCommandResponse

Response returned when a command is successfully issued against a given Deployment resource

Example

{}

DeploymentResourceCrudResponse

A response returned from the Deployment Resource endpoints

Properties

id (string, required)
The id of the deployment
kind (string, required)
The kind of the stateless resource
ref_id (string, required)
The reference id of the resource

Example

{
   "id" : "string",
   "kind" : "string",
   "ref_id" : "string"
}

DeploymentResourceUpgradeResponse

Intentionally left blank

Properties

resource_id (string, required)
stack_version (string, required)

Example

{
   "resource_id" : "string",
   "stack_version" : "string"
}

DeploymentResources

Describes a resource belonging to a Deployment

Properties

apm (array[ApmResourceInfo], required)
List of Apm resources in your Deployment
appsearch (array[AppSearchResourceInfo], required)
List of App Search resources in your Deployment
elasticsearch (array[ElasticsearchResourceInfo], required)
List of Elasticsearch resources in your Deployment
enterprise_search (array[EnterpriseSearchResourceInfo], required)
List of Enterprise Search resources in your Deployment
kibana (array[KibanaResourceInfo], required)
List of Kibana resources in your Deployment

Example

{
   "apm" : [
      {
         "elasticsearch_cluster_ref_id" : "string",
         "id" : "string",
         "info" : {
            "deployment_id" : "string",
            "elasticsearch_cluster" : {
               "elasticsearch_id" : "string",
               "links" : {
                  "some_property" : {
                     "need_elevated_permissions" : true
                  }
               }
            },
            "external_links" : [
               {
                  "id" : "string",
                  "label" : "string",
                  "uri" : "string"
               }
            ],
            "healthy" : true,
            "id" : "string",
            "links" : {
               "some_property" : null
            },
            "metadata" : {
               "cloud_id" : "string",
               "endpoint" : "string",
               "last_modified" : "2019-01-01T00:00:00Z",
               "ports" : {
                  "http" : 0,
                  "https" : 0
               },
               "raw" : {},
               "version" : 0
            },
            "name" : "string",
            "plan_info" : {
               "current" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "healthy" : true,
                  "plan" : {
                     "apm" : {
                        "docker_image" : "string",
                        "system_settings" : {
                           "debug_enabled" : true,
                           "elasticsearch_password" : "string",
                           "elasticsearch_url" : "string",
                           "elasticsearch_username" : "string",
                           "kibana_url" : "string",
                           "secret_token" : "string"
                        },
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "cluster_topology" : [
                        {
                           "apm" : null,
                           "instance_configuration_id" : "string",
                           "size" : {
                              "resource" : "string",
                              "value" : 0
                           },
                           "zone_count" : 0
                        }
                     ],
                     "transient" : {
                        "plan_configuration" : {
                           "calm_wait_time" : 0,
                           "cluster_reboot" : "string",
                           "extended_maintenance" : true,
                           "timeout" : 0
                        },
                        "strategy" : {
                           "autodetect" : {},
                           "grow_and_shrink" : {},
                           "rolling" : {
                              "allow_inline_resize" : true,
                              "group_by" : "string",
                              "shard_init_wait_time" : 0,
                              "skip_synced_flush" : true
                           },
                           "rolling_grow_and_shrink" : {}
                        }
                     }
                  },
                  "plan_attempt_id" : "string",
                  "plan_attempt_log" : [
                     {
                        "completed" : "2019-01-01T00:00:00Z",
                        "duration_in_millis" : 0,
                        "info_log" : [
                           {
                              "delta_in_millis" : 0,
                              "message" : "string",
                              "stage" : "string",
                              "timestamp" : "2019-01-01T00:00:00Z"
                           }
                        ],
                        "stage" : "string",
                        "started" : "2019-01-01T00:00:00Z",
                        "status" : "string",
                        "step_id" : "string"
                     }
                  ],
                  "plan_attempt_name" : "string",
                  "plan_end_time" : "2019-01-01T00:00:00Z",
                  "source" : {
                     "action" : "string",
                     "admin_id" : "string",
                     "date" : "2019-01-01T00:00:00Z",
                     "facilitator" : "string",
                     "remote_addresses" : [
                        "string"
                     ],
                     "user_id" : "string"
                  }
               },
               "healthy" : true,
               "history" : [
                  null
               ],
               "pending" : null
            },
            "region" : "string",
            "settings" : {
               "metadata" : {
                  "name" : "string"
               }
            },
            "status" : "string",
            "topology" : {
               "healthy" : true,
               "instances" : [
                  {
                     "allocator_id" : "string",
                     "container_started" : true,
                     "disk" : {
                        "disk_space_available" : 0,
                        "disk_space_used" : 0,
                        "storage_multiplier" : 0.1
                     },
                     "healthy" : true,
                     "instance_configuration" : {
                        "id" : "string",
                        "name" : "string",
                        "resource" : "string"
                     },
                     "instance_name" : "string",
                     "maintenance_mode" : true,
                     "memory" : {
                        "instance_capacity" : 0,
                        "instance_capacity_planned" : 0,
                        "memory_pressure" : 0,
                        "native_memory_pressure" : 0
                     },
                     "service_id" : "string",
                     "service_roles" : [
                        "string"
                     ],
                     "service_running" : true,
                     "service_version" : "string",
                     "zone" : "string"
                  }
               ]
            }
         },
         "ref_id" : "string",
         "region" : "string"
      }
   ],
   "appsearch" : [
      {
         "elasticsearch_cluster_ref_id" : "string",
         "id" : "string",
         "info" : {
            "deployment_id" : "string",
            "elasticsearch_cluster" : null,
            "external_links" : [
               null
            ],
            "healthy" : true,
            "id" : "string",
            "links" : {
               "some_property" : null
            },
            "metadata" : null,
            "name" : "string",
            "plan_info" : {
               "current" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "healthy" : true,
                  "plan" : {
                     "appsearch" : {
                        "docker_image" : "string",
                        "system_settings" : {
                           "elasticsearch_password" : "string",
                           "elasticsearch_url" : "string",
                           "elasticsearch_username" : "string",
                           "secret_session_key" : "string"
                        },
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "cluster_topology" : [
                        {
                           "appsearch" : null,
                           "instance_configuration_id" : "string",
                           "node_type" : {
                              "appserver" : true,
                              "worker" : true
                           },
                           "size" : null,
                           "zone_count" : 0
                        }
                     ],
                     "transient" : {
                        "plan_configuration" : {
                           "calm_wait_time" : 0,
                           "cluster_reboot" : "string",
                           "extended_maintenance" : true,
                           "move_allocators" : [
                              {
                                 "allocator_down" : true,
                                 "from" : "string",
                                 "to" : [
                                    "string"
                                 ]
                              }
                           ],
                           "move_instances" : [
                              {
                                 "from" : "string",
                                 "instance_down" : true,
                                 "to" : [
                                    "string"
                                 ]
                              }
                           ],
                           "preferred_allocators" : [
                              "string"
                           ],
                           "reallocate_instances" : true,
                           "timeout" : 0
                        },
                        "strategy" : null
                     }
                  },
                  "plan_attempt_id" : "string",
                  "plan_attempt_log" : [
                     null
                  ],
                  "plan_attempt_name" : "string",
                  "plan_end_time" : "2019-01-01T00:00:00Z",
                  "source" : null
               },
               "healthy" : true,
               "history" : [
                  null
               ],
               "pending" : null
            },
            "region" : "string",
            "settings" : {
               "metadata" : null
            },
            "status" : "string",
            "topology" : null
         },
         "ref_id" : "string",
         "region" : "string"
      }
   ],
   "elasticsearch" : [
      {
         "id" : "string",
         "info" : {
            "associated_apm_clusters" : [
               {
                  "apm_id" : "string",
                  "enabled" : true,
                  "links" : {
                     "some_property" : null
                  }
               }
            ],
            "associated_appsearch_clusters" : [
               {
                  "app_search_id" : "string",
                  "enabled" : true,
                  "links" : {
                     "some_property" : null
                  }
               }
            ],
            "associated_enterprise_search_clusters" : [
               {
                  "enabled" : true,
                  "enterprise_search_id" : "string",
                  "links" : {
                     "some_property" : null
                  }
               }
            ],
            "associated_kibana_clusters" : [
               {
                  "enabled" : true,
                  "kibana_id" : "string",
                  "links" : {
                     "some_property" : null
                  }
               }
            ],
            "ccs" : {
               "healthy" : true,
               "remote_clusters" : [
                  {
                     "compatible" : true,
                     "id" : "string",
                     "version" : "string"
                  }
               ]
            },
            "cluster_id" : "string",
            "cluster_name" : "string",
            "deployment_id" : "string",
            "elasticsearch" : {
               "blocking_issues" : {
                  "cluster_level" : [
                     {
                        "description" : "string",
                        "instances" : [
                           "string"
                        ]
                     }
                  ],
                  "healthy" : true,
                  "index_level" : [
                     null
                  ]
               },
               "healthy" : true,
               "master_info" : {
                  "healthy" : true,
                  "instances_with_no_master" : [
                     "string"
                  ],
                  "masters" : [
                     {
                        "instances" : [
                           "string"
                        ],
                        "master_instance_name" : "string",
                        "master_node_id" : "string"
                     }
                  ]
               },
               "shard_info" : {
                  "available_shards" : [
                     {
                        "instance_name" : "string",
                        "shard_count" : 0
                     }
                  ],
                  "healthy" : true,
                  "unavailable_replicas" : [
                     {
                        "instance_name" : "string",
                        "replica_count" : 0
                     }
                  ],
                  "unavailable_shards" : [
                     null
                  ]
               }
            },
            "elasticsearch_monitoring_info" : {
               "destination_cluster_ids" : [
                  "string"
               ],
               "healthy" : true,
               "last_modified" : "2019-01-01T00:00:00Z",
               "last_update_status" : "string",
               "source_cluster_ids" : [
                  "string"
               ]
            },
            "external_links" : [
               null
            ],
            "healthy" : true,
            "links" : {
               "some_property" : null
            },
            "metadata" : null,
            "plan_info" : {
               "current" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "healthy" : true,
                  "plan" : {
                     "cluster_topology" : [
                        {
                           "elasticsearch" : {
                              "curation" : {
                                 "from_instance_configuration_id" : "string",
                                 "to_instance_configuration_id" : "string"
                              },
                              "docker_image" : "string",
                              "enabled_built_in_plugins" : [
                                 "string"
                              ],
                              "node_attributes" : {
                                 "some_property" : "string"
                              },
                              "system_settings" : {
                                 "auto_create_index" : true,
                                 "default_shards_per_index" : 0,
                                 "destructive_requires_name" : true,
                                 "enable_close_index" : true,
                                 "monitoring_collection_interval" : 0,
                                 "monitoring_history_duration" : "string",
                                 "reindex_whitelist" : [
                                    "string"
                                 ],
                                 "scripting" : {
                                    "expressions_enabled" : true,
                                    "file" : {
                                       "enabled" : true,
                                       "sandbox_mode" : true
                                    },
                                    "inline" : null,
                                    "mustache_enabled" : true,
                                    "painless_enabled" : true,
                                    "stored" : null
                                 },
                                 "use_disk_threshold" : true,
                                 "watcher_trigger_engine" : "string"
                              },
                              "user_bundles" : [
                                 {
                                    "elasticsearch_version" : "string",
                                    "name" : "string",
                                    "url" : "string"
                                 }
                              ],
                              "user_plugins" : [
                                 {
                                    "elasticsearch_version" : "string",
                                    "name" : "string",
                                    "url" : "string"
                                 }
                              ],
                              "user_settings_json" : {},
                              "user_settings_override_json" : {},
                              "user_settings_override_yaml" : "string",
                              "user_settings_yaml" : "string",
                              "version" : "string"
                           },
                           "instance_configuration_id" : "string",
                           "node_type" : {
                              "data" : true,
                              "ingest" : true,
                              "master" : true,
                              "ml" : true
                           },
                           "size" : null,
                           "zone_count" : 0
                        }
                     ],
                     "deployment_template" : {
                        "id" : "string",
                        "version" : "string"
                     },
                     "elasticsearch" : null,
                     "transient" : {
                        "cluster_settings_json" : {},
                        "plan_configuration" : {
                           "calm_wait_time" : 0,
                           "cluster_reboot" : "string",
                           "extended_maintenance" : true,
                           "max_snapshot_age" : 0,
                           "max_snapshot_attempts" : 0,
                           "skip_snapshot" : true,
                           "timeout" : 0
                        },
                        "restore_snapshot" : {
                           "repository_config" : {
                              "raw_settings" : {}
                           },
                           "repository_name" : "string",
                           "restore_payload" : {
                              "indices" : [
                                 "string"
                              ],
                              "raw_settings" : {}
                           },
                           "snapshot_name" : "string",
                           "source_cluster_id" : "string",
                           "strategy" : "string"
                        },
                        "strategy" : null
                     }
                  },
                  "plan_attempt_id" : "string",
                  "plan_attempt_log" : [
                     null
                  ],
                  "plan_attempt_name" : "string",
                  "plan_end_time" : "2019-01-01T00:00:00Z",
                  "source" : null
               },
               "healthy" : true,
               "history" : [
                  null
               ],
               "pending" : null
            },
            "region" : "string",
            "security" : {
               "last_modified" : "2019-01-01T00:00:00Z",
               "roles" : {},
               "users" : [
                  {
                     "password_hash" : "string",
                     "username" : "string"
                  }
               ],
               "users_roles" : [
                  {
                     "roles" : [
                        "string"
                     ],
                     "username" : "string"
                  }
               ],
               "version" : 0
            },
            "settings" : {
               "ccs" : {
                  "remote_clusters" : {
                     "some_property" : {
                        "cluster_id" : "string",
                        "skip_unavailable" : true
                     }
                  }
               },
               "curation" : {
                  "specs" : [
                     {
                        "index_pattern" : "string",
                        "trigger_interval_seconds" : 0
                     }
                  ]
               },
               "dedicated_masters_threshold" : 0,
               "ip_filtering" : {
                  "rulesets" : [
                     "string"
                  ]
               },
               "metadata" : null,
               "monitoring" : {
                  "target_cluster_id" : "string"
               },
               "snapshot" : {
                  "cron_expression" : "string",
                  "interval" : "string",
                  "retention" : {
                     "max_age" : "string",
                     "snapshots" : 0
                  },
                  "slm" : true
               }
            },
            "snapshots" : {
               "count" : 0,
               "healthy" : true,
               "latest_end_time" : "2019-01-01T00:00:00Z",
               "latest_status" : "string",
               "latest_successful" : true,
               "latest_successful_end_time" : "2019-01-01T00:00:00Z",
               "recent_success" : true,
               "scheduled_time" : "2019-01-01T00:00:00Z"
            },
            "status" : "string",
            "system_alerts" : [
               {
                  "alert_type" : "string",
                  "exit_code" : 0,
                  "instance_name" : "string",
                  "timestamp" : "2019-01-01T00:00:00Z",
                  "url" : "string"
               }
            ],
            "topology" : null
         },
         "ref_id" : "string",
         "region" : "string"
      }
   ],
   "enterprise_search" : [
      {
         "elasticsearch_cluster_ref_id" : "string",
         "id" : "string",
         "info" : {
            "deployment_id" : "string",
            "elasticsearch_cluster" : null,
            "external_links" : [
               null
            ],
            "healthy" : true,
            "id" : "string",
            "links" : {
               "some_property" : null
            },
            "metadata" : null,
            "name" : "string",
            "plan_info" : {
               "current" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "healthy" : true,
                  "plan" : {
                     "cluster_topology" : [
                        {
                           "allocator_filter" : {},
                           "enterprise_search" : {
                              "docker_image" : "string",
                              "system_settings" : {
                                 "elasticsearch_password" : "string",
                                 "elasticsearch_url" : "string",
                                 "elasticsearch_username" : "string",
                                 "secret_session_key" : "string"
                              },
                              "user_settings_json" : {},
                              "user_settings_override_json" : {},
                              "user_settings_override_yaml" : "string",
                              "user_settings_yaml" : "string",
                              "version" : "string"
                           },
                           "instance_configuration_id" : "string",
                           "memory_per_node" : {},
                           "node_configuration" : "string",
                           "node_count_per_zone" : {},
                           "node_type" : {
                              "appserver" : true,
                              "connector" : true,
                              "worker" : true
                           },
                           "size" : null,
                           "zone_count" : 0
                        }
                     ],
                     "enterprise_search" : null,
                     "transient" : {
                        "plan_configuration" : {
                           "calm_wait_time" : 0,
                           "cluster_reboot" : "string",
                           "extended_maintenance" : true,
                           "move_allocators" : [
                              null
                           ],
                           "move_instances" : [
                              null
                           ],
                           "preferred_allocators" : [
                              "string"
                           ],
                           "reallocate_instances" : true,
                           "timeout" : 0
                        },
                        "strategy" : null
                     }
                  },
                  "plan_attempt_id" : "string",
                  "plan_attempt_log" : [
                     null
                  ],
                  "plan_attempt_name" : "string",
                  "plan_end_time" : "2019-01-01T00:00:00Z",
                  "source" : null
               },
               "healthy" : true,
               "history" : [
                  null
               ],
               "pending" : null
            },
            "region" : "string",
            "settings" : {
               "metadata" : null
            },
            "status" : "string",
            "topology" : null
         },
         "ref_id" : "string",
         "region" : "string"
      }
   ],
   "kibana" : [
      {
         "elasticsearch_cluster_ref_id" : "string",
         "id" : "string",
         "info" : {
            "cluster_id" : "string",
            "cluster_name" : "string",
            "deployment_id" : "string",
            "elasticsearch_cluster" : null,
            "external_links" : [
               null
            ],
            "healthy" : true,
            "links" : {
               "some_property" : null
            },
            "metadata" : null,
            "plan_info" : {
               "current" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "healthy" : true,
                  "plan" : {
                     "cluster_topology" : [
                        {
                           "instance_configuration_id" : "string",
                           "kibana" : {
                              "docker_image" : "string",
                              "system_settings" : {
                                 "elasticsearch_password" : "string",
                                 "elasticsearch_url" : "string",
                                 "elasticsearch_username" : "string"
                              },
                              "user_settings_json" : {},
                              "user_settings_override_json" : {},
                              "user_settings_override_yaml" : "string",
                              "user_settings_yaml" : "string",
                              "version" : "string"
                           },
                           "size" : null,
                           "zone_count" : 0
                        }
                     ],
                     "kibana" : null,
                     "transient" : {
                        "plan_configuration" : {
                           "calm_wait_time" : 0,
                           "cluster_reboot" : "string",
                           "extended_maintenance" : true,
                           "timeout" : 0
                        },
                        "strategy" : null
                     }
                  },
                  "plan_attempt_id" : "string",
                  "plan_attempt_log" : [
                     null
                  ],
                  "plan_attempt_name" : "string",
                  "plan_end_time" : "2019-01-01T00:00:00Z",
                  "source" : null
               },
               "healthy" : true,
               "history" : [
                  null
               ],
               "pending" : null
            },
            "region" : "string",
            "settings" : {
               "metadata" : null
            },
            "status" : "string",
            "topology" : null
         },
         "ref_id" : "string",
         "region" : "string"
      }
   ]
}

DeploymentRestoreResponse

A response returned from the Deployment restore endpoint

Properties

id (string, required)
The id of the deployment

Example

{
   "id" : "string"
}

DeploymentSearchResponse

Describes a searched Deployment

Properties

healthy (boolean, required)
Whether the deployment is overall healthy or not (one or more of the resource info subsections will have healthy: false)
id (string, required)
A randomly-generated id of this Deployment
name (string, required)
The name of this deployment
resources (DeploymentResources, required)
The Resources that belong to this Deployment
settings (DeploymentSettings)
Additional configuration for this Deployment

Example

{
   "healthy" : true,
   "id" : "string",
   "name" : "string",
   "resources" : {
      "apm" : [
         {
            "elasticsearch_cluster_ref_id" : "string",
            "id" : "string",
            "info" : {
               "deployment_id" : "string",
               "elasticsearch_cluster" : {
                  "elasticsearch_id" : "string",
                  "links" : {
                     "some_property" : {
                        "need_elevated_permissions" : true
                     }
                  }
               },
               "external_links" : [
                  {
                     "id" : "string",
                     "label" : "string",
                     "uri" : "string"
                  }
               ],
               "healthy" : true,
               "id" : "string",
               "links" : {
                  "some_property" : null
               },
               "metadata" : {
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0
                  },
                  "raw" : {},
                  "version" : 0
               },
               "name" : "string",
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "healthy" : true,
                     "plan" : {
                        "apm" : {
                           "docker_image" : "string",
                           "system_settings" : {
                              "debug_enabled" : true,
                              "elasticsearch_password" : "string",
                              "elasticsearch_url" : "string",
                              "elasticsearch_username" : "string",
                              "kibana_url" : "string",
                              "secret_token" : "string"
                           },
                           "user_settings_json" : {},
                           "user_settings_override_json" : {},
                           "user_settings_override_yaml" : "string",
                           "user_settings_yaml" : "string",
                           "version" : "string"
                        },
                        "cluster_topology" : [
                           {
                              "apm" : null,
                              "instance_configuration_id" : "string",
                              "size" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "zone_count" : 0
                           }
                        ],
                        "transient" : {
                           "plan_configuration" : {
                              "calm_wait_time" : 0,
                              "cluster_reboot" : "string",
                              "extended_maintenance" : true,
                              "timeout" : 0
                           },
                           "strategy" : {
                              "autodetect" : {},
                              "grow_and_shrink" : {},
                              "rolling" : {
                                 "allow_inline_resize" : true,
                                 "group_by" : "string",
                                 "shard_init_wait_time" : 0,
                                 "skip_synced_flush" : true
                              },
                              "rolling_grow_and_shrink" : {}
                           }
                        }
                     },
                     "plan_attempt_id" : "string",
                     "plan_attempt_log" : [
                        {
                           "completed" : "2019-01-01T00:00:00Z",
                           "duration_in_millis" : 0,
                           "info_log" : [
                              {
                                 "delta_in_millis" : 0,
                                 "message" : "string",
                                 "stage" : "string",
                                 "timestamp" : "2019-01-01T00:00:00Z"
                              }
                           ],
                           "stage" : "string",
                           "started" : "2019-01-01T00:00:00Z",
                           "status" : "string",
                           "step_id" : "string"
                        }
                     ],
                     "plan_attempt_name" : "string",
                     "plan_end_time" : "2019-01-01T00:00:00Z",
                     "source" : {
                        "action" : "string",
                        "admin_id" : "string",
                        "date" : "2019-01-01T00:00:00Z",
                        "facilitator" : "string",
                        "remote_addresses" : [
                           "string"
                        ],
                        "user_id" : "string"
                     }
                  },
                  "healthy" : true,
                  "history" : [
                     null
                  ],
                  "pending" : null
               },
               "region" : "string",
               "settings" : {
                  "metadata" : {
                     "name" : "string"
                  }
               },
               "status" : "string",
               "topology" : {
                  "healthy" : true,
                  "instances" : [
                     {
                        "allocator_id" : "string",
                        "container_started" : true,
                        "disk" : {
                           "disk_space_available" : 0,
                           "disk_space_used" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "healthy" : true,
                        "instance_configuration" : {
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "service_id" : "string",
                        "service_roles" : [
                           "string"
                        ],
                        "service_running" : true,
                        "service_version" : "string",
                        "zone" : "string"
                     }
                  ]
               }
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ],
      "appsearch" : [
         {
            "elasticsearch_cluster_ref_id" : "string",
            "id" : "string",
            "info" : {
               "deployment_id" : "string",
               "elasticsearch_cluster" : null,
               "external_links" : [
                  null
               ],
               "healthy" : true,
               "id" : "string",
               "links" : {
                  "some_property" : null
               },
               "metadata" : null,
               "name" : "string",
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "healthy" : true,
                     "plan" : {
                        "appsearch" : {
                           "docker_image" : "string",
                           "system_settings" : {
                              "elasticsearch_password" : "string",
                              "elasticsearch_url" : "string",
                              "elasticsearch_username" : "string",
                              "secret_session_key" : "string"
                           },
                           "user_settings_json" : {},
                           "user_settings_override_json" : {},
                           "user_settings_override_yaml" : "string",
                           "user_settings_yaml" : "string",
                           "version" : "string"
                        },
                        "cluster_topology" : [
                           {
                              "appsearch" : null,
                              "instance_configuration_id" : "string",
                              "node_type" : {
                                 "appserver" : true,
                                 "worker" : true
                              },
                              "size" : null,
                              "zone_count" : 0
                           }
                        ],
                        "transient" : {
                           "plan_configuration" : {
                              "calm_wait_time" : 0,
                              "cluster_reboot" : "string",
                              "extended_maintenance" : true,
                              "move_allocators" : [
                                 {
                                    "allocator_down" : true,
                                    "from" : "string",
                                    "to" : [
                                       "string"
                                    ]
                                 }
                              ],
                              "move_instances" : [
                                 {
                                    "from" : "string",
                                    "instance_down" : true,
                                    "to" : [
                                       "string"
                                    ]
                                 }
                              ],
                              "preferred_allocators" : [
                                 "string"
                              ],
                              "reallocate_instances" : true,
                              "timeout" : 0
                           },
                           "strategy" : null
                        }
                     },
                     "plan_attempt_id" : "string",
                     "plan_attempt_log" : [
                        null
                     ],
                     "plan_attempt_name" : "string",
                     "plan_end_time" : "2019-01-01T00:00:00Z",
                     "source" : null
                  },
                  "healthy" : true,
                  "history" : [
                     null
                  ],
                  "pending" : null
               },
               "region" : "string",
               "settings" : {
                  "metadata" : null
               },
               "status" : "string",
               "topology" : null
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ],
      "elasticsearch" : [
         {
            "id" : "string",
            "info" : {
               "associated_apm_clusters" : [
                  {
                     "apm_id" : "string",
                     "enabled" : true,
                     "links" : {
                        "some_property" : null
                     }
                  }
               ],
               "associated_appsearch_clusters" : [
                  {
                     "app_search_id" : "string",
                     "enabled" : true,
                     "links" : {
                        "some_property" : null
                     }
                  }
               ],
               "associated_enterprise_search_clusters" : [
                  {
                     "enabled" : true,
                     "enterprise_search_id" : "string",
                     "links" : {
                        "some_property" : null
                     }
                  }
               ],
               "associated_kibana_clusters" : [
                  {
                     "enabled" : true,
                     "kibana_id" : "string",
                     "links" : {
                        "some_property" : null
                     }
                  }
               ],
               "ccs" : {
                  "healthy" : true,
                  "remote_clusters" : [
                     {
                        "compatible" : true,
                        "id" : "string",
                        "version" : "string"
                     }
                  ]
               },
               "cluster_id" : "string",
               "cluster_name" : "string",
               "deployment_id" : "string",
               "elasticsearch" : {
                  "blocking_issues" : {
                     "cluster_level" : [
                        {
                           "description" : "string",
                           "instances" : [
                              "string"
                           ]
                        }
                     ],
                     "healthy" : true,
                     "index_level" : [
                        null
                     ]
                  },
                  "healthy" : true,
                  "master_info" : {
                     "healthy" : true,
                     "instances_with_no_master" : [
                        "string"
                     ],
                     "masters" : [
                        {
                           "instances" : [
                              "string"
                           ],
                           "master_instance_name" : "string",
                           "master_node_id" : "string"
                        }
                     ]
                  },
                  "shard_info" : {
                     "available_shards" : [
                        {
                           "instance_name" : "string",
                           "shard_count" : 0
                        }
                     ],
                     "healthy" : true,
                     "unavailable_replicas" : [
                        {
                           "instance_name" : "string",
                           "replica_count" : 0
                        }
                     ],
                     "unavailable_shards" : [
                        null
                     ]
                  }
               },
               "elasticsearch_monitoring_info" : {
                  "destination_cluster_ids" : [
                     "string"
                  ],
                  "healthy" : true,
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "last_update_status" : "string",
                  "source_cluster_ids" : [
                     "string"
                  ]
               },
               "external_links" : [
                  null
               ],
               "healthy" : true,
               "links" : {
                  "some_property" : null
               },
               "metadata" : null,
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "elasticsearch" : {
                                 "curation" : {
                                    "from_instance_configuration_id" : "string",
                                    "to_instance_configuration_id" : "string"
                                 },
                                 "docker_image" : "string",
                                 "enabled_built_in_plugins" : [
                                    "string"
                                 ],
                                 "node_attributes" : {
                                    "some_property" : "string"
                                 },
                                 "system_settings" : {
                                    "auto_create_index" : true,
                                    "default_shards_per_index" : 0,
                                    "destructive_requires_name" : true,
                                    "enable_close_index" : true,
                                    "monitoring_collection_interval" : 0,
                                    "monitoring_history_duration" : "string",
                                    "reindex_whitelist" : [
                                       "string"
                                    ],
                                    "scripting" : {
                                       "expressions_enabled" : true,
                                       "file" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       },
                                       "inline" : null,
                                       "mustache_enabled" : true,
                                       "painless_enabled" : true,
                                       "stored" : null
                                    },
                                    "use_disk_threshold" : true,
                                    "watcher_trigger_engine" : "string"
                                 },
                                 "user_bundles" : [
                                    {
                                       "elasticsearch_version" : "string",
                                       "name" : "string",
                                       "url" : "string"
                                    }
                                 ],
                                 "user_plugins" : [
                                    {
                                       "elasticsearch_version" : "string",
                                       "name" : "string",
                                       "url" : "string"
                                    }
                                 ],
                                 "user_settings_json" : {},
                                 "user_settings_override_json" : {},
                                 "user_settings_override_yaml" : "string",
                                 "user_settings_yaml" : "string",
                                 "version" : "string"
                              },
                              "instance_configuration_id" : "string",
                              "node_type" : {
                                 "data" : true,
                                 "ingest" : true,
                                 "master" : true,
                                 "ml" : true
                              },
                              "size" : null,
                              "zone_count" : 0
                           }
                        ],
                        "deployment_template" : {
                           "id" : "string",
                           "version" : "string"
                        },
                        "elasticsearch" : null,
                        "transient" : {
                           "cluster_settings_json" : {},
                           "plan_configuration" : {
                              "calm_wait_time" : 0,
                              "cluster_reboot" : "string",
                              "extended_maintenance" : true,
                              "max_snapshot_age" : 0,
                              "max_snapshot_attempts" : 0,
                              "skip_snapshot" : true,
                              "timeout" : 0
                           },
                           "restore_snapshot" : {
                              "repository_config" : {
                                 "raw_settings" : {}
                              },
                              "repository_name" : "string",
                              "restore_payload" : {
                                 "indices" : [
                                    "string"
                                 ],
                                 "raw_settings" : {}
                              },
                              "snapshot_name" : "string",
                              "source_cluster_id" : "string",
                              "strategy" : "string"
                           },
                           "strategy" : null
                        }
                     },
                     "plan_attempt_id" : "string",
                     "plan_attempt_log" : [
                        null
                     ],
                     "plan_attempt_name" : "string",
                     "plan_end_time" : "2019-01-01T00:00:00Z",
                     "source" : null
                  },
                  "healthy" : true,
                  "history" : [
                     null
                  ],
                  "pending" : null
               },
               "region" : "string",
               "security" : {
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "roles" : {},
                  "users" : [
                     {
                        "password_hash" : "string",
                        "username" : "string"
                     }
                  ],
                  "users_roles" : [
                     {
                        "roles" : [
                           "string"
                        ],
                        "username" : "string"
                     }
                  ],
                  "version" : 0
               },
               "settings" : {
                  "ccs" : {
                     "remote_clusters" : {
                        "some_property" : {
                           "cluster_id" : "string",
                           "skip_unavailable" : true
                        }
                     }
                  },
                  "curation" : {
                     "specs" : [
                        {
                           "index_pattern" : "string",
                           "trigger_interval_seconds" : 0
                        }
                     ]
                  },
                  "dedicated_masters_threshold" : 0,
                  "ip_filtering" : {
                     "rulesets" : [
                        "string"
                     ]
                  },
                  "metadata" : null,
                  "monitoring" : {
                     "target_cluster_id" : "string"
                  },
                  "snapshot" : {
                     "cron_expression" : "string",
                     "interval" : "string",
                     "retention" : {
                        "max_age" : "string",
                        "snapshots" : 0
                     },
                     "slm" : true
                  }
               },
               "snapshots" : {
                  "count" : 0,
                  "healthy" : true,
                  "latest_end_time" : "2019-01-01T00:00:00Z",
                  "latest_status" : "string",
                  "latest_successful" : true,
                  "latest_successful_end_time" : "2019-01-01T00:00:00Z",
                  "recent_success" : true,
                  "scheduled_time" : "2019-01-01T00:00:00Z"
               },
               "status" : "string",
               "system_alerts" : [
                  {
                     "alert_type" : "string",
                     "exit_code" : 0,
                     "instance_name" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z",
                     "url" : "string"
                  }
               ],
               "topology" : null
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ],
      "enterprise_search" : [
         {
            "elasticsearch_cluster_ref_id" : "string",
            "id" : "string",
            "info" : {
               "deployment_id" : "string",
               "elasticsearch_cluster" : null,
               "external_links" : [
                  null
               ],
               "healthy" : true,
               "id" : "string",
               "links" : {
                  "some_property" : null
               },
               "metadata" : null,
               "name" : "string",
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "allocator_filter" : {},
                              "enterprise_search" : {
                                 "docker_image" : "string",
                                 "system_settings" : {
                                    "elasticsearch_password" : "string",
                                    "elasticsearch_url" : "string",
                                    "elasticsearch_username" : "string",
                                    "secret_session_key" : "string"
                                 },
                                 "user_settings_json" : {},
                                 "user_settings_override_json" : {},
                                 "user_settings_override_yaml" : "string",
                                 "user_settings_yaml" : "string",
                                 "version" : "string"
                              },
                              "instance_configuration_id" : "string",
                              "memory_per_node" : {},
                              "node_configuration" : "string",
                              "node_count_per_zone" : {},
                              "node_type" : {
                                 "appserver" : true,
                                 "connector" : true,
                                 "worker" : true
                              },
                              "size" : null,
                              "zone_count" : 0
                           }
                        ],
                        "enterprise_search" : null,
                        "transient" : {
                           "plan_configuration" : {
                              "calm_wait_time" : 0,
                              "cluster_reboot" : "string",
                              "extended_maintenance" : true,
                              "move_allocators" : [
                                 null
                              ],
                              "move_instances" : [
                                 null
                              ],
                              "preferred_allocators" : [
                                 "string"
                              ],
                              "reallocate_instances" : true,
                              "timeout" : 0
                           },
                           "strategy" : null
                        }
                     },
                     "plan_attempt_id" : "string",
                     "plan_attempt_log" : [
                        null
                     ],
                     "plan_attempt_name" : "string",
                     "plan_end_time" : "2019-01-01T00:00:00Z",
                     "source" : null
                  },
                  "healthy" : true,
                  "history" : [
                     null
                  ],
                  "pending" : null
               },
               "region" : "string",
               "settings" : {
                  "metadata" : null
               },
               "status" : "string",
               "topology" : null
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ],
      "kibana" : [
         {
            "elasticsearch_cluster_ref_id" : "string",
            "id" : "string",
            "info" : {
               "cluster_id" : "string",
               "cluster_name" : "string",
               "deployment_id" : "string",
               "elasticsearch_cluster" : null,
               "external_links" : [
                  null
               ],
               "healthy" : true,
               "links" : {
                  "some_property" : null
               },
               "metadata" : null,
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "instance_configuration_id" : "string",
                              "kibana" : {
                                 "docker_image" : "string",
                                 "system_settings" : {
                                    "elasticsearch_password" : "string",
                                    "elasticsearch_url" : "string",
                                    "elasticsearch_username" : "string"
                                 },
                                 "user_settings_json" : {},
                                 "user_settings_override_json" : {},
                                 "user_settings_override_yaml" : "string",
                                 "user_settings_yaml" : "string",
                                 "version" : "string"
                              },
                              "size" : null,
                              "zone_count" : 0
                           }
                        ],
                        "kibana" : null,
                        "transient" : {
                           "plan_configuration" : {
                              "calm_wait_time" : 0,
                              "cluster_reboot" : "string",
                              "extended_maintenance" : true,
                              "timeout" : 0
                           },
                           "strategy" : null
                        }
                     },
                     "plan_attempt_id" : "string",
                     "plan_attempt_log" : [
                        null
                     ],
                     "plan_attempt_name" : "string",
                     "plan_end_time" : "2019-01-01T00:00:00Z",
                     "source" : null
                  },
                  "healthy" : true,
                  "history" : [
                     null
                  ],
                  "pending" : null
               },
               "region" : "string",
               "settings" : {
                  "metadata" : null
               },
               "status" : "string",
               "topology" : null
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ]
   },
   "settings" : {
      "ip_filtering_settings" : null
   }
}

DeploymentSettings

Additional configuration about the current deployment object.

Properties

ip_filtering_settings (IpFilteringSettings)
The set of rulesets applies to this deployment.

Example

{
   "ip_filtering_settings" : {
      "rulesets" : [
         "string"
      ]
   }
}

DeploymentShutdownResponse

A response returned from the Deployment shutdown endpoint

Properties

id (string, required)
The id of the deployment
name (string, required)
The name of the deployment
orphaned (Orphaned)
Details about orphaned resources

Example

{
   "id" : "string",
   "name" : "string",
   "orphaned" : {
      "apm" : [
         "string"
      ],
      "appsearch" : [
         "string"
      ],
      "elasticsearch" : [
         {
            "dependents" : [
               {
                  "id" : "string",
                  "kind" : "string"
               }
            ],
            "id" : "string"
         }
      ],
      "enterprise_search" : [
         "string"
      ],
      "kibana" : [
         "string"
      ]
   }
}

DeploymentTemplateReference

Specifies the deployment template used to create the plan.

Properties

id (string, required)
The unique identifier of the deployment template
version (string)
A version identifier to disambiguate multiple revisions of the same template

Example

{
   "id" : "string",
   "version" : "string"
}

DeploymentUpdateRequest

A request for updating a Deployment consisting of multiple resources

Properties

name (string)
A new name for the deployment, otherwise stays the same.
prune_orphans (boolean, required)
Whether or not to prune orphan resources that are no longer mentioned in this request. Note that resourcesare tracked by ref_id, and if a resource's ref_id is changed, any previous running resources created with that previousref_id are considered to be orphaned as well.
resources (DeploymentUpdateResources)
New information about the Resources that will have this Deployment, otherwise they stay the same

Example

{
   "name" : "string",
   "prune_orphans" : true,
   "resources" : {
      "apm" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "plan" : {
               "apm" : {
                  "docker_image" : "string",
                  "system_settings" : {
                     "debug_enabled" : true,
                     "elasticsearch_password" : "string",
                     "elasticsearch_url" : "string",
                     "elasticsearch_username" : "string",
                     "kibana_url" : "string",
                     "secret_token" : "string"
                  },
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "cluster_topology" : [
                  {
                     "apm" : null,
                     "instance_configuration_id" : "string",
                     "size" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "zone_count" : 0
                  }
               ],
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "timeout" : 0
                  },
                  "strategy" : {
                     "autodetect" : {},
                     "grow_and_shrink" : {},
                     "rolling" : {
                        "allow_inline_resize" : true,
                        "group_by" : "string",
                        "shard_init_wait_time" : 0,
                        "skip_synced_flush" : true
                     },
                     "rolling_grow_and_shrink" : {}
                  }
               }
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "metadata" : {
                  "name" : "string"
               }
            }
         }
      ],
      "appsearch" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "plan" : {
               "appsearch" : {
                  "docker_image" : "string",
                  "system_settings" : {
                     "elasticsearch_password" : "string",
                     "elasticsearch_url" : "string",
                     "elasticsearch_username" : "string",
                     "secret_session_key" : "string"
                  },
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "cluster_topology" : [
                  {
                     "appsearch" : null,
                     "instance_configuration_id" : "string",
                     "node_type" : {
                        "appserver" : true,
                        "worker" : true
                     },
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "move_allocators" : [
                        {
                           "allocator_down" : true,
                           "from" : "string",
                           "to" : [
                              "string"
                           ]
                        }
                     ],
                     "move_instances" : [
                        {
                           "from" : "string",
                           "instance_down" : true,
                           "to" : [
                              "string"
                           ]
                        }
                     ],
                     "preferred_allocators" : [
                        "string"
                     ],
                     "reallocate_instances" : true,
                     "timeout" : 0
                  },
                  "strategy" : null
               }
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "metadata" : null
            }
         }
      ],
      "elasticsearch" : [
         {
            "display_name" : "string",
            "plan" : {
               "cluster_topology" : [
                  {
                     "elasticsearch" : {
                        "curation" : {
                           "from_instance_configuration_id" : "string",
                           "to_instance_configuration_id" : "string"
                        },
                        "docker_image" : "string",
                        "enabled_built_in_plugins" : [
                           "string"
                        ],
                        "node_attributes" : {
                           "some_property" : "string"
                        },
                        "system_settings" : {
                           "auto_create_index" : true,
                           "default_shards_per_index" : 0,
                           "destructive_requires_name" : true,
                           "enable_close_index" : true,
                           "monitoring_collection_interval" : 0,
                           "monitoring_history_duration" : "string",
                           "reindex_whitelist" : [
                              "string"
                           ],
                           "scripting" : {
                              "expressions_enabled" : true,
                              "file" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              },
                              "inline" : null,
                              "mustache_enabled" : true,
                              "painless_enabled" : true,
                              "stored" : null
                           },
                           "use_disk_threshold" : true,
                           "watcher_trigger_engine" : "string"
                        },
                        "user_bundles" : [
                           {
                              "elasticsearch_version" : "string",
                              "name" : "string",
                              "url" : "string"
                           }
                        ],
                        "user_plugins" : [
                           {
                              "elasticsearch_version" : "string",
                              "name" : "string",
                              "url" : "string"
                           }
                        ],
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "instance_configuration_id" : "string",
                     "node_type" : {
                        "data" : true,
                        "ingest" : true,
                        "master" : true,
                        "ml" : true
                     },
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "deployment_template" : {
                  "id" : "string",
                  "version" : "string"
               },
               "elasticsearch" : null,
               "transient" : {
                  "cluster_settings_json" : {},
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "max_snapshot_age" : 0,
                     "max_snapshot_attempts" : 0,
                     "skip_snapshot" : true,
                     "timeout" : 0
                  },
                  "restore_snapshot" : {
                     "repository_config" : {
                        "raw_settings" : {}
                     },
                     "repository_name" : "string",
                     "restore_payload" : {
                        "indices" : [
                           "string"
                        ],
                        "raw_settings" : {}
                     },
                     "snapshot_name" : "string",
                     "source_cluster_id" : "string",
                     "strategy" : "string"
                  },
                  "strategy" : null
               }
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "ccs" : {
                  "remote_clusters" : {
                     "some_property" : {
                        "cluster_id" : "string",
                        "skip_unavailable" : true
                     }
                  }
               },
               "curation" : {
                  "specs" : [
                     {
                        "index_pattern" : "string",
                        "trigger_interval_seconds" : 0
                     }
                  ]
               },
               "dedicated_masters_threshold" : 0,
               "ip_filtering" : {
                  "rulesets" : [
                     "string"
                  ]
               },
               "metadata" : null,
               "monitoring" : {
                  "target_cluster_id" : "string"
               },
               "snapshot" : {
                  "cron_expression" : "string",
                  "interval" : "string",
                  "retention" : {
                     "max_age" : "string",
                     "snapshots" : 0
                  },
                  "slm" : true
               }
            }
         }
      ],
      "kibana" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "plan" : {
               "cluster_topology" : [
                  {
                     "instance_configuration_id" : "string",
                     "kibana" : {
                        "docker_image" : "string",
                        "system_settings" : {
                           "elasticsearch_password" : "string",
                           "elasticsearch_url" : "string",
                           "elasticsearch_username" : "string"
                        },
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "kibana" : null,
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "timeout" : 0
                  },
                  "strategy" : null
               }
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "metadata" : null
            }
         }
      ]
   }
}

DeploymentUpdateResources

Describes the resources that will have the Deployment

Properties

apm (array[ApmPayload])
A list of payloads for APM updates
appsearch (array[AppSearchPayload])
A list of payloads for AppSearch updates
elasticsearch (array[ElasticsearchPayload])
A list of payloads for Elasticsearch cluster updates
kibana (array[KibanaPayload])
A list of payloads for Kibana updates

Example

{
   "apm" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "plan" : {
            "apm" : {
               "docker_image" : "string",
               "system_settings" : {
                  "debug_enabled" : true,
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string",
                  "kibana_url" : "string",
                  "secret_token" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "cluster_topology" : [
               {
                  "apm" : null,
                  "instance_configuration_id" : "string",
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "timeout" : 0
               },
               "strategy" : {
                  "autodetect" : {},
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "metadata" : {
               "name" : "string"
            }
         }
      }
   ],
   "appsearch" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "plan" : {
            "appsearch" : {
               "docker_image" : "string",
               "system_settings" : {
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string",
                  "secret_session_key" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "cluster_topology" : [
               {
                  "appsearch" : null,
                  "instance_configuration_id" : "string",
                  "node_type" : {
                     "appserver" : true,
                     "worker" : true
                  },
                  "size" : null,
                  "zone_count" : 0
               }
            ],
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "move_allocators" : [
                     {
                        "allocator_down" : true,
                        "from" : "string",
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "move_instances" : [
                     {
                        "from" : "string",
                        "instance_down" : true,
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "timeout" : 0
               },
               "strategy" : null
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "metadata" : null
         }
      }
   ],
   "elasticsearch" : [
      {
         "display_name" : "string",
         "plan" : {
            "cluster_topology" : [
               {
                  "elasticsearch" : {
                     "curation" : {
                        "from_instance_configuration_id" : "string",
                        "to_instance_configuration_id" : "string"
                     },
                     "docker_image" : "string",
                     "enabled_built_in_plugins" : [
                        "string"
                     ],
                     "node_attributes" : {
                        "some_property" : "string"
                     },
                     "system_settings" : {
                        "auto_create_index" : true,
                        "default_shards_per_index" : 0,
                        "destructive_requires_name" : true,
                        "enable_close_index" : true,
                        "monitoring_collection_interval" : 0,
                        "monitoring_history_duration" : "string",
                        "reindex_whitelist" : [
                           "string"
                        ],
                        "scripting" : {
                           "expressions_enabled" : true,
                           "file" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           },
                           "inline" : null,
                           "mustache_enabled" : true,
                           "painless_enabled" : true,
                           "stored" : null
                        },
                        "use_disk_threshold" : true,
                        "watcher_trigger_engine" : "string"
                     },
                     "user_bundles" : [
                        {
                           "elasticsearch_version" : "string",
                           "name" : "string",
                           "url" : "string"
                        }
                     ],
                     "user_plugins" : [
                        {
                           "elasticsearch_version" : "string",
                           "name" : "string",
                           "url" : "string"
                        }
                     ],
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "instance_configuration_id" : "string",
                  "node_type" : {
                     "data" : true,
                     "ingest" : true,
                     "master" : true,
                     "ml" : true
                  },
                  "size" : null,
                  "zone_count" : 0
               }
            ],
            "deployment_template" : {
               "id" : "string",
               "version" : "string"
            },
            "elasticsearch" : null,
            "transient" : {
               "cluster_settings_json" : {},
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "max_snapshot_age" : 0,
                  "max_snapshot_attempts" : 0,
                  "skip_snapshot" : true,
                  "timeout" : 0
               },
               "restore_snapshot" : {
                  "repository_config" : {
                     "raw_settings" : {}
                  },
                  "repository_name" : "string",
                  "restore_payload" : {
                     "indices" : [
                        "string"
                     ],
                     "raw_settings" : {}
                  },
                  "snapshot_name" : "string",
                  "source_cluster_id" : "string",
                  "strategy" : "string"
               },
               "strategy" : null
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "ccs" : {
               "remote_clusters" : {
                  "some_property" : {
                     "cluster_id" : "string",
                     "skip_unavailable" : true
                  }
               }
            },
            "curation" : {
               "specs" : [
                  {
                     "index_pattern" : "string",
                     "trigger_interval_seconds" : 0
                  }
               ]
            },
            "dedicated_masters_threshold" : 0,
            "ip_filtering" : {
               "rulesets" : [
                  "string"
               ]
            },
            "metadata" : null,
            "monitoring" : {
               "target_cluster_id" : "string"
            },
            "snapshot" : {
               "cron_expression" : "string",
               "interval" : "string",
               "retention" : {
                  "max_age" : "string",
                  "snapshots" : 0
               },
               "slm" : true
            }
         }
      }
   ],
   "kibana" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "plan" : {
            "cluster_topology" : [
               {
                  "instance_configuration_id" : "string",
                  "kibana" : {
                     "docker_image" : "string",
                     "system_settings" : {
                        "elasticsearch_password" : "string",
                        "elasticsearch_url" : "string",
                        "elasticsearch_username" : "string"
                     },
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "size" : null,
                  "zone_count" : 0
               }
            ],
            "kibana" : null,
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "timeout" : 0
               },
               "strategy" : null
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "metadata" : null
         }
      }
   ]
}

DeploymentUpdateResponse

A response returned from the Deployment update endpoint

Properties

diagnostics (DeploymentDiagnostics)
Backend diagnostics. Sent if validation is requested.
id (string, required)
The id of the deployment
name (string, required)
The name of the deployment
resources (array[DeploymentResource], required)
List of resources that are part of the deployment after the update operation.
shutdown_resources (Orphaned)
List of resources that have been shut down

Example

{
   "diagnostics" : {
      "creates" : {
         "apm" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ],
         "appsearch" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ],
         "elasticsearch" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "ref_id" : "string"
            }
         ],
         "enterprise_search" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ],
         "kibana" : [
            {
               "backend_plan" : {},
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "ref_id" : "string"
            }
         ]
      },
      "updates" : {
         "apm" : [
            null
         ],
         "appsearch" : [
            null
         ],
         "elasticsearch" : [
            null
         ],
         "enterprise_search" : [
            null
         ],
         "kibana" : [
            null
         ]
      }
   },
   "id" : "string",
   "name" : "string",
   "resources" : [
      {
         "cloud_id" : "string",
         "credentials" : {
            "password" : "string",
            "username" : "string"
         },
         "elasticsearch_cluster_ref_id" : "string",
         "id" : "string",
         "kind" : "string",
         "ref_id" : "string",
         "region" : "string",
         "secret_token" : "string"
      }
   ],
   "shutdown_resources" : {
      "apm" : [
         "string"
      ],
      "appsearch" : [
         "string"
      ],
      "elasticsearch" : [
         {
            "dependents" : [
               {
                  "id" : "string",
                  "kind" : "string"
               }
            ],
            "id" : "string"
         }
      ],
      "enterprise_search" : [
         "string"
      ],
      "kibana" : [
         "string"
      ]
   }
}

DeploymentsListResponse

Contains a list of deployments

Properties

deployments (array[DeploymentsListingData], required)
The deployments

Example

{
   "deployments" : [
      {
         "id" : "string",
         "name" : "string",
         "resources" : [
            {
               "cloud_id" : "string",
               "credentials" : {
                  "password" : "string",
                  "username" : "string"
               },
               "elasticsearch_cluster_ref_id" : "string",
               "id" : "string",
               "kind" : "string",
               "ref_id" : "string",
               "region" : "string",
               "secret_token" : "string"
            }
         ]
      }
   ]
}

DeploymentsListingData

Intentionally left blank

Properties

id (string, required)
The id of this deployment
name (string, required)
The name of this deployment
resources (array[DeploymentResource], required)
List of resources in this deployment

Example

{
   "id" : "string",
   "name" : "string",
   "resources" : [
      {
         "cloud_id" : "string",
         "credentials" : {
            "password" : "string",
            "username" : "string"
         },
         "elasticsearch_cluster_ref_id" : "string",
         "id" : "string",
         "kind" : "string",
         "ref_id" : "string",
         "region" : "string",
         "secret_token" : "string"
      }
   ]
}

DeploymentsSearchResponse

Contains a list of Deployments as result of a search request.

Properties

deployments (array[DeploymentSearchResponse], required)
match_count (integer as int32)
If a query is supplied, then the total number of deployments that matched
return_count (integer as int32, required)
The number of deployments actually returned

Example

{
   "deployments" : [
      {
         "healthy" : true,
         "id" : "string",
         "name" : "string",
         "resources" : {
            "apm" : [
               {
                  "elasticsearch_cluster_ref_id" : "string",
                  "id" : "string",
                  "info" : {
                     "deployment_id" : "string",
                     "elasticsearch_cluster" : {
                        "elasticsearch_id" : "string",
                        "links" : {
                           "some_property" : {
                              "need_elevated_permissions" : true
                           }
                        }
                     },
                     "external_links" : [
                        {
                           "id" : "string",
                           "label" : "string",
                           "uri" : "string"
                        }
                     ],
                     "healthy" : true,
                     "id" : "string",
                     "links" : {
                        "some_property" : null
                     },
                     "metadata" : {
                        "cloud_id" : "string",
                        "endpoint" : "string",
                        "last_modified" : "2019-01-01T00:00:00Z",
                        "ports" : {
                           "http" : 0,
                           "https" : 0
                        },
                        "raw" : {},
                        "version" : 0
                     },
                     "name" : "string",
                     "plan_info" : {
                        "current" : {
                           "attempt_end_time" : "2019-01-01T00:00:00Z",
                           "attempt_start_time" : "2019-01-01T00:00:00Z",
                           "healthy" : true,
                           "plan" : {
                              "apm" : {
                                 "docker_image" : "string",
                                 "system_settings" : {
                                    "debug_enabled" : true,
                                    "elasticsearch_password" : "string",
                                    "elasticsearch_url" : "string",
                                    "elasticsearch_username" : "string",
                                    "kibana_url" : "string",
                                    "secret_token" : "string"
                                 },
                                 "user_settings_json" : {},
                                 "user_settings_override_json" : {},
                                 "user_settings_override_yaml" : "string",
                                 "user_settings_yaml" : "string",
                                 "version" : "string"
                              },
                              "cluster_topology" : [
                                 {
                                    "apm" : null,
                                    "instance_configuration_id" : "string",
                                    "size" : {
                                       "resource" : "string",
                                       "value" : 0
                                    },
                                    "zone_count" : 0
                                 }
                              ],
                              "transient" : {
                                 "plan_configuration" : {
                                    "calm_wait_time" : 0,
                                    "cluster_reboot" : "string",
                                    "extended_maintenance" : true,
                                    "timeout" : 0
                                 },
                                 "strategy" : {
                                    "autodetect" : {},
                                    "grow_and_shrink" : {},
                                    "rolling" : {
                                       "allow_inline_resize" : true,
                                       "group_by" : "string",
                                       "shard_init_wait_time" : 0,
                                       "skip_synced_flush" : true
                                    },
                                    "rolling_grow_and_shrink" : {}
                                 }
                              }
                           },
                           "plan_attempt_id" : "string",
                           "plan_attempt_log" : [
                              {
                                 "completed" : "2019-01-01T00:00:00Z",
                                 "duration_in_millis" : 0,
                                 "info_log" : [
                                    {
                                       "delta_in_millis" : 0,
                                       "message" : "string",
                                       "stage" : "string",
                                       "timestamp" : "2019-01-01T00:00:00Z"
                                    }
                                 ],
                                 "stage" : "string",
                                 "started" : "2019-01-01T00:00:00Z",
                                 "status" : "string",
                                 "step_id" : "string"
                              }
                           ],
                           "plan_attempt_name" : "string",
                           "plan_end_time" : "2019-01-01T00:00:00Z",
                           "source" : {
                              "action" : "string",
                              "admin_id" : "string",
                              "date" : "2019-01-01T00:00:00Z",
                              "facilitator" : "string",
                              "remote_addresses" : [
                                 "string"
                              ],
                              "user_id" : "string"
                           }
                        },
                        "healthy" : true,
                        "history" : [
                           null
                        ],
                        "pending" : null
                     },
                     "region" : "string",
                     "settings" : {
                        "metadata" : {
                           "name" : "string"
                        }
                     },
                     "status" : "string",
                     "topology" : {
                        "healthy" : true,
                        "instances" : [
                           {
                              "allocator_id" : "string",
                              "container_started" : true,
                              "disk" : {
                                 "disk_space_available" : 0,
                                 "disk_space_used" : 0,
                                 "storage_multiplier" : 0.1
                              },
                              "healthy" : true,
                              "instance_configuration" : {
                                 "id" : "string",
                                 "name" : "string",
                                 "resource" : "string"
                              },
                              "instance_name" : "string",
                              "maintenance_mode" : true,
                              "memory" : {
                                 "instance_capacity" : 0,
                                 "instance_capacity_planned" : 0,
                                 "memory_pressure" : 0,
                                 "native_memory_pressure" : 0
                              },
                              "service_id" : "string",
                              "service_roles" : [
                                 "string"
                              ],
                              "service_running" : true,
                              "service_version" : "string",
                              "zone" : "string"
                           }
                        ]
                     }
                  },
                  "ref_id" : "string",
                  "region" : "string"
               }
            ],
            "appsearch" : [
               {
                  "elasticsearch_cluster_ref_id" : "string",
                  "id" : "string",
                  "info" : {
                     "deployment_id" : "string",
                     "elasticsearch_cluster" : null,
                     "external_links" : [
                        null
                     ],
                     "healthy" : true,
                     "id" : "string",
                     "links" : {
                        "some_property" : null
                     },
                     "metadata" : null,
                     "name" : "string",
                     "plan_info" : {
                        "current" : {
                           "attempt_end_time" : "2019-01-01T00:00:00Z",
                           "attempt_start_time" : "2019-01-01T00:00:00Z",
                           "healthy" : true,
                           "plan" : {
                              "appsearch" : {
                                 "docker_image" : "string",
                                 "system_settings" : {
                                    "elasticsearch_password" : "string",
                                    "elasticsearch_url" : "string",
                                    "elasticsearch_username" : "string",
                                    "secret_session_key" : "string"
                                 },
                                 "user_settings_json" : {},
                                 "user_settings_override_json" : {},
                                 "user_settings_override_yaml" : "string",
                                 "user_settings_yaml" : "string",
                                 "version" : "string"
                              },
                              "cluster_topology" : [
                                 {
                                    "appsearch" : null,
                                    "instance_configuration_id" : "string",
                                    "node_type" : {
                                       "appserver" : true,
                                       "worker" : true
                                    },
                                    "size" : null,
                                    "zone_count" : 0
                                 }
                              ],
                              "transient" : {
                                 "plan_configuration" : {
                                    "calm_wait_time" : 0,
                                    "cluster_reboot" : "string",
                                    "extended_maintenance" : true,
                                    "move_allocators" : [
                                       {
                                          "allocator_down" : true,
                                          "from" : "string",
                                          "to" : [
                                             "string"
                                          ]
                                       }
                                    ],
                                    "move_instances" : [
                                       {
                                          "from" : "string",
                                          "instance_down" : true,
                                          "to" : [
                                             "string"
                                          ]
                                       }
                                    ],
                                    "preferred_allocators" : [
                                       "string"
                                    ],
                                    "reallocate_instances" : true,
                                    "timeout" : 0
                                 },
                                 "strategy" : null
                              }
                           },
                           "plan_attempt_id" : "string",
                           "plan_attempt_log" : [
                              null
                           ],
                           "plan_attempt_name" : "string",
                           "plan_end_time" : "2019-01-01T00:00:00Z",
                           "source" : null
                        },
                        "healthy" : true,
                        "history" : [
                           null
                        ],
                        "pending" : null
                     },
                     "region" : "string",
                     "settings" : {
                        "metadata" : null
                     },
                     "status" : "string",
                     "topology" : null
                  },
                  "ref_id" : "string",
                  "region" : "string"
               }
            ],
            "elasticsearch" : [
               {
                  "id" : "string",
                  "info" : {
                     "associated_apm_clusters" : [
                        {
                           "apm_id" : "string",
                           "enabled" : true,
                           "links" : {
                              "some_property" : null
                           }
                        }
                     ],
                     "associated_appsearch_clusters" : [
                        {
                           "app_search_id" : "string",
                           "enabled" : true,
                           "links" : {
                              "some_property" : null
                           }
                        }
                     ],
                     "associated_enterprise_search_clusters" : [
                        {
                           "enabled" : true,
                           "enterprise_search_id" : "string",
                           "links" : {
                              "some_property" : null
                           }
                        }
                     ],
                     "associated_kibana_clusters" : [
                        {
                           "enabled" : true,
                           "kibana_id" : "string",
                           "links" : {
                              "some_property" : null
                           }
                        }
                     ],
                     "ccs" : {
                        "healthy" : true,
                        "remote_clusters" : [
                           {
                              "compatible" : true,
                              "id" : "string",
                              "version" : "string"
                           }
                        ]
                     },
                     "cluster_id" : "string",
                     "cluster_name" : "string",
                     "deployment_id" : "string",
                     "elasticsearch" : {
                        "blocking_issues" : {
                           "cluster_level" : [
                              {
                                 "description" : "string",
                                 "instances" : [
                                    "string"
                                 ]
                              }
                           ],
                           "healthy" : true,
                           "index_level" : [
                              null
                           ]
                        },
                        "healthy" : true,
                        "master_info" : {
                           "healthy" : true,
                           "instances_with_no_master" : [
                              "string"
                           ],
                           "masters" : [
                              {
                                 "instances" : [
                                    "string"
                                 ],
                                 "master_instance_name" : "string",
                                 "master_node_id" : "string"
                              }
                           ]
                        },
                        "shard_info" : {
                           "available_shards" : [
                              {
                                 "instance_name" : "string",
                                 "shard_count" : 0
                              }
                           ],
                           "healthy" : true,
                           "unavailable_replicas" : [
                              {
                                 "instance_name" : "string",
                                 "replica_count" : 0
                              }
                           ],
                           "unavailable_shards" : [
                              null
                           ]
                        }
                     },
                     "elasticsearch_monitoring_info" : {
                        "destination_cluster_ids" : [
                           "string"
                        ],
                        "healthy" : true,
                        "last_modified" : "2019-01-01T00:00:00Z",
                        "last_update_status" : "string",
                        "source_cluster_ids" : [
                           "string"
                        ]
                     },
                     "external_links" : [
                        null
                     ],
                     "healthy" : true,
                     "links" : {
                        "some_property" : null
                     },
                     "metadata" : null,
                     "plan_info" : {
                        "current" : {
                           "attempt_end_time" : "2019-01-01T00:00:00Z",
                           "attempt_start_time" : "2019-01-01T00:00:00Z",
                           "healthy" : true,
                           "plan" : {
                              "cluster_topology" : [
                                 {
                                    "elasticsearch" : {
                                       "curation" : {
                                          "from_instance_configuration_id" : "string",
                                          "to_instance_configuration_id" : "string"
                                       },
                                       "docker_image" : "string",
                                       "enabled_built_in_plugins" : [
                                          "string"
                                       ],
                                       "node_attributes" : {
                                          "some_property" : "string"
                                       },
                                       "system_settings" : {
                                          "auto_create_index" : true,
                                          "default_shards_per_index" : 0,
                                          "destructive_requires_name" : true,
                                          "enable_close_index" : true,
                                          "monitoring_collection_interval" : 0,
                                          "monitoring_history_duration" : "string",
                                          "reindex_whitelist" : [
                                             "string"
                                          ],
                                          "scripting" : {
                                             "expressions_enabled" : true,
                                             "file" : {
                                                "enabled" : true,
                                                "sandbox_mode" : true
                                             },
                                             "inline" : null,
                                             "mustache_enabled" : true,
                                             "painless_enabled" : true,
                                             "stored" : null
                                          },
                                          "use_disk_threshold" : true,
                                          "watcher_trigger_engine" : "string"
                                       },
                                       "user_bundles" : [
                                          {
                                             "elasticsearch_version" : "string",
                                             "name" : "string",
                                             "url" : "string"
                                          }
                                       ],
                                       "user_plugins" : [
                                          {
                                             "elasticsearch_version" : "string",
                                             "name" : "string",
                                             "url" : "string"
                                          }
                                       ],
                                       "user_settings_json" : {},
                                       "user_settings_override_json" : {},
                                       "user_settings_override_yaml" : "string",
                                       "user_settings_yaml" : "string",
                                       "version" : "string"
                                    },
                                    "instance_configuration_id" : "string",
                                    "node_type" : {
                                       "data" : true,
                                       "ingest" : true,
                                       "master" : true,
                                       "ml" : true
                                    },
                                    "size" : null,
                                    "zone_count" : 0
                                 }
                              ],
                              "deployment_template" : {
                                 "id" : "string",
                                 "version" : "string"
                              },
                              "elasticsearch" : null,
                              "transient" : {
                                 "cluster_settings_json" : {},
                                 "plan_configuration" : {
                                    "calm_wait_time" : 0,
                                    "cluster_reboot" : "string",
                                    "extended_maintenance" : true,
                                    "max_snapshot_age" : 0,
                                    "max_snapshot_attempts" : 0,
                                    "skip_snapshot" : true,
                                    "timeout" : 0
                                 },
                                 "restore_snapshot" : {
                                    "repository_config" : {
                                       "raw_settings" : {}
                                    },
                                    "repository_name" : "string",
                                    "restore_payload" : {
                                       "indices" : [
                                          "string"
                                       ],
                                       "raw_settings" : {}
                                    },
                                    "snapshot_name" : "string",
                                    "source_cluster_id" : "string",
                                    "strategy" : "string"
                                 },
                                 "strategy" : null
                              }
                           },
                           "plan_attempt_id" : "string",
                           "plan_attempt_log" : [
                              null
                           ],
                           "plan_attempt_name" : "string",
                           "plan_end_time" : "2019-01-01T00:00:00Z",
                           "source" : null
                        },
                        "healthy" : true,
                        "history" : [
                           null
                        ],
                        "pending" : null
                     },
                     "region" : "string",
                     "security" : {
                        "last_modified" : "2019-01-01T00:00:00Z",
                        "roles" : {},
                        "users" : [
                           {
                              "password_hash" : "string",
                              "username" : "string"
                           }
                        ],
                        "users_roles" : [
                           {
                              "roles" : [
                                 "string"
                              ],
                              "username" : "string"
                           }
                        ],
                        "version" : 0
                     },
                     "settings" : {
                        "ccs" : {
                           "remote_clusters" : {
                              "some_property" : {
                                 "cluster_id" : "string",
                                 "skip_unavailable" : true
                              }
                           }
                        },
                        "curation" : {
                           "specs" : [
                              {
                                 "index_pattern" : "string",
                                 "trigger_interval_seconds" : 0
                              }
                           ]
                        },
                        "dedicated_masters_threshold" : 0,
                        "ip_filtering" : {
                           "rulesets" : [
                              "string"
                           ]
                        },
                        "metadata" : null,
                        "monitoring" : {
                           "target_cluster_id" : "string"
                        },
                        "snapshot" : {
                           "cron_expression" : "string",
                           "interval" : "string",
                           "retention" : {
                              "max_age" : "string",
                              "snapshots" : 0
                           },
                           "slm" : true
                        }
                     },
                     "snapshots" : {
                        "count" : 0,
                        "healthy" : true,
                        "latest_end_time" : "2019-01-01T00:00:00Z",
                        "latest_status" : "string",
                        "latest_successful" : true,
                        "latest_successful_end_time" : "2019-01-01T00:00:00Z",
                        "recent_success" : true,
                        "scheduled_time" : "2019-01-01T00:00:00Z"
                     },
                     "status" : "string",
                     "system_alerts" : [
                        {
                           "alert_type" : "string",
                           "exit_code" : 0,
                           "instance_name" : "string",
                           "timestamp" : "2019-01-01T00:00:00Z",
                           "url" : "string"
                        }
                     ],
                     "topology" : null
                  },
                  "ref_id" : "string",
                  "region" : "string"
               }
            ],
            "enterprise_search" : [
               {
                  "elasticsearch_cluster_ref_id" : "string",
                  "id" : "string",
                  "info" : {
                     "deployment_id" : "string",
                     "elasticsearch_cluster" : null,
                     "external_links" : [
                        null
                     ],
                     "healthy" : true,
                     "id" : "string",
                     "links" : {
                        "some_property" : null
                     },
                     "metadata" : null,
                     "name" : "string",
                     "plan_info" : {
                        "current" : {
                           "attempt_end_time" : "2019-01-01T00:00:00Z",
                           "attempt_start_time" : "2019-01-01T00:00:00Z",
                           "healthy" : true,
                           "plan" : {
                              "cluster_topology" : [
                                 {
                                    "allocator_filter" : {},
                                    "enterprise_search" : {
                                       "docker_image" : "string",
                                       "system_settings" : {
                                          "elasticsearch_password" : "string",
                                          "elasticsearch_url" : "string",
                                          "elasticsearch_username" : "string",
                                          "secret_session_key" : "string"
                                       },
                                       "user_settings_json" : {},
                                       "user_settings_override_json" : {},
                                       "user_settings_override_yaml" : "string",
                                       "user_settings_yaml" : "string",
                                       "version" : "string"
                                    },
                                    "instance_configuration_id" : "string",
                                    "memory_per_node" : {},
                                    "node_configuration" : "string",
                                    "node_count_per_zone" : {},
                                    "node_type" : {
                                       "appserver" : true,
                                       "connector" : true,
                                       "worker" : true
                                    },
                                    "size" : null,
                                    "zone_count" : 0
                                 }
                              ],
                              "enterprise_search" : null,
                              "transient" : {
                                 "plan_configuration" : {
                                    "calm_wait_time" : 0,
                                    "cluster_reboot" : "string",
                                    "extended_maintenance" : true,
                                    "move_allocators" : [
                                       null
                                    ],
                                    "move_instances" : [
                                       null
                                    ],
                                    "preferred_allocators" : [
                                       "string"
                                    ],
                                    "reallocate_instances" : true,
                                    "timeout" : 0
                                 },
                                 "strategy" : null
                              }
                           },
                           "plan_attempt_id" : "string",
                           "plan_attempt_log" : [
                              null
                           ],
                           "plan_attempt_name" : "string",
                           "plan_end_time" : "2019-01-01T00:00:00Z",
                           "source" : null
                        },
                        "healthy" : true,
                        "history" : [
                           null
                        ],
                        "pending" : null
                     },
                     "region" : "string",
                     "settings" : {
                        "metadata" : null
                     },
                     "status" : "string",
                     "topology" : null
                  },
                  "ref_id" : "string",
                  "region" : "string"
               }
            ],
            "kibana" : [
               {
                  "elasticsearch_cluster_ref_id" : "string",
                  "id" : "string",
                  "info" : {
                     "cluster_id" : "string",
                     "cluster_name" : "string",
                     "deployment_id" : "string",
                     "elasticsearch_cluster" : null,
                     "external_links" : [
                        null
                     ],
                     "healthy" : true,
                     "links" : {
                        "some_property" : null
                     },
                     "metadata" : null,
                     "plan_info" : {
                        "current" : {
                           "attempt_end_time" : "2019-01-01T00:00:00Z",
                           "attempt_start_time" : "2019-01-01T00:00:00Z",
                           "healthy" : true,
                           "plan" : {
                              "cluster_topology" : [
                                 {
                                    "instance_configuration_id" : "string",
                                    "kibana" : {
                                       "docker_image" : "string",
                                       "system_settings" : {
                                          "elasticsearch_password" : "string",
                                          "elasticsearch_url" : "string",
                                          "elasticsearch_username" : "string"
                                       },
                                       "user_settings_json" : {},
                                       "user_settings_override_json" : {},
                                       "user_settings_override_yaml" : "string",
                                       "user_settings_yaml" : "string",
                                       "version" : "string"
                                    },
                                    "size" : null,
                                    "zone_count" : 0
                                 }
                              ],
                              "kibana" : null,
                              "transient" : {
                                 "plan_configuration" : {
                                    "calm_wait_time" : 0,
                                    "cluster_reboot" : "string",
                                    "extended_maintenance" : true,
                                    "timeout" : 0
                                 },
                                 "strategy" : null
                              }
                           },
                           "plan_attempt_id" : "string",
                           "plan_attempt_log" : [
                              null
                           ],
                           "plan_attempt_name" : "string",
                           "plan_end_time" : "2019-01-01T00:00:00Z",
                           "source" : null
                        },
                        "healthy" : true,
                        "history" : [
                           null
                        ],
                        "pending" : null
                     },
                     "region" : "string",
                     "settings" : {
                        "metadata" : null
                     },
                     "status" : "string",
                     "topology" : null
                  },
                  "ref_id" : "string",
                  "region" : "string"
               }
            ]
         },
         "settings" : {
            "ip_filtering_settings" : null
         }
      }
   ],
   "match_count" : 0,
   "return_count" : 0
}

Elasticsearch

Holds diagnostics for an Elasticsearch cluster

Properties

backend_plan (object, required)
The backend plan as JSON
display_name (string, required)
The human readable name for the cluster (defaults to the generated cluster id if not specified)
ref_id (string, required)
A locally-unique user-specified id

Example

{
   "backend_plan" : {},
   "display_name" : "string",
   "ref_id" : "string"
}

ElasticsearchClusterBlockingIssueElement

Information about an issue and the Elasticsearch instance it affects.

Properties

description (string, required)
Description of the issue
instances (array[string], required)
A list of instances that are affected by the issue

Example

{
   "description" : "string",
   "instances" : [
      "string"
   ]
}

ElasticsearchClusterBlockingIssues

Issues that prevent the Elasticsearch cluster or index from correctly operating.

Properties

cluster_level (array[ElasticsearchClusterBlockingIssueElement], required)
A list of issues that affect availability of entire cluster
healthy (boolean, required)
Whether the cluster has issues (false) or not (true)
index_level (array[ElasticsearchClusterBlockingIssueElement], required)
A list of issues that affect availability of the cluster's indices

Example

{
   "cluster_level" : [
      {
         "description" : "string",
         "instances" : [
            "string"
         ]
      }
   ],
   "healthy" : true,
   "index_level" : [
      null
   ]
}

ElasticsearchClusterInfo

The information for an Elasticsearch cluster.

Properties

associated_apm_clusters (array[ApmSubInfo], required)
associated_appsearch_clusters (array[AppSearchSubInfo], required)
associated_enterprise_search_clusters (array[EnterpriseSearchSubInfo], required)
associated_kibana_clusters (array[KibanaSubClusterInfo], required)
ccs (CrossClusterSearchInfo)
Cross-cluster search settings and status for this cluster.
cluster_id (string, required)
The id of the cluster
cluster_name (string, required)
The name of the cluster
deployment_id (string)
The id of the deployment that this Elasticsearch belongs to.
elasticsearch (ElasticsearchInfo, required)
Information about the Elasticsearch cluster.
elasticsearch_monitoring_info (ElasticsearchMonitoringInfo)
Information about the monitoring status for the Elasticsearch cluster.
external_links (array[ExternalHyperlink], required)
External resources related to the cluster
healthy (boolean, required)
Whether the cluster is healthy or not (one or more of the info subsections will have healthy: false)
links (map[string,Hyperlink])
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
metadata (ClusterMetadataInfo, required)
Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.
plan_info (ElasticsearchClusterPlansInfo, required)
Information about the current, pending, and past Elasticsearch cluster plans.
region (string)
The region that this cluster belongs to. Only populated in SaaS or federated ECE.
security (ElasticsearchClusterSecurityInfo)
For 2.x Elasticsearch clusters, specifies the information about the users and roles. For 5.x Elasticsearch clusters, use the Kibana management UI.
settings (ElasticsearchClusterSettings)
The settings for an Elasticsearch cluster.
snapshots (SnapshotStatusInfo, required)
Information about the snapshot status for the Elasticsearch cluster. For example, the health status.
status (string; allowed values: [initializing, stopping, stopped, rebooting, restarting, reconfiguring, started], required)
Cluster status
system_alerts (array[ClusterSystemAlert])
List of cluster system alerts
topology (ClusterTopologyInfo, required)
The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.

Example

{
   "associated_apm_clusters" : [
      {
         "apm_id" : "string",
         "enabled" : true,
         "links" : {
            "some_property" : {
               "need_elevated_permissions" : true
            }
         }
      }
   ],
   "associated_appsearch_clusters" : [
      {
         "app_search_id" : "string",
         "enabled" : true,
         "links" : {
            "some_property" : null
         }
      }
   ],
   "associated_enterprise_search_clusters" : [
      {
         "enabled" : true,
         "enterprise_search_id" : "string",
         "links" : {
            "some_property" : null
         }
      }
   ],
   "associated_kibana_clusters" : [
      {
         "enabled" : true,
         "kibana_id" : "string",
         "links" : {
            "some_property" : null
         }
      }
   ],
   "ccs" : {
      "healthy" : true,
      "remote_clusters" : [
         {
            "compatible" : true,
            "id" : "string",
            "version" : "string"
         }
      ]
   },
   "cluster_id" : "string",
   "cluster_name" : "string",
   "deployment_id" : "string",
   "elasticsearch" : {
      "blocking_issues" : {
         "cluster_level" : [
            {
               "description" : "string",
               "instances" : [
                  "string"
               ]
            }
         ],
         "healthy" : true,
         "index_level" : [
            null
         ]
      },
      "healthy" : true,
      "master_info" : {
         "healthy" : true,
         "instances_with_no_master" : [
            "string"
         ],
         "masters" : [
            {
               "instances" : [
                  "string"
               ],
               "master_instance_name" : "string",
               "master_node_id" : "string"
            }
         ]
      },
      "shard_info" : {
         "available_shards" : [
            {
               "instance_name" : "string",
               "shard_count" : 0
            }
         ],
         "healthy" : true,
         "unavailable_replicas" : [
            {
               "instance_name" : "string",
               "replica_count" : 0
            }
         ],
         "unavailable_shards" : [
            null
         ]
      }
   },
   "elasticsearch_monitoring_info" : {
      "destination_cluster_ids" : [
         "string"
      ],
      "healthy" : true,
      "last_modified" : "2019-01-01T00:00:00Z",
      "last_update_status" : "string",
      "source_cluster_ids" : [
         "string"
      ]
   },
   "external_links" : [
      {
         "id" : "string",
         "label" : "string",
         "uri" : "string"
      }
   ],
   "healthy" : true,
   "links" : {
      "some_property" : null
   },
   "metadata" : {
      "cloud_id" : "string",
      "endpoint" : "string",
      "last_modified" : "2019-01-01T00:00:00Z",
      "ports" : {
         "http" : 0,
         "https" : 0
      },
      "raw" : {},
      "version" : 0
   },
   "plan_info" : {
      "current" : {
         "attempt_end_time" : "2019-01-01T00:00:00Z",
         "attempt_start_time" : "2019-01-01T00:00:00Z",
         "healthy" : true,
         "plan" : {
            "cluster_topology" : [
               {
                  "elasticsearch" : {
                     "curation" : {
                        "from_instance_configuration_id" : "string",
                        "to_instance_configuration_id" : "string"
                     },
                     "docker_image" : "string",
                     "enabled_built_in_plugins" : [
                        "string"
                     ],
                     "node_attributes" : {
                        "some_property" : "string"
                     },
                     "system_settings" : {
                        "auto_create_index" : true,
                        "default_shards_per_index" : 0,
                        "destructive_requires_name" : true,
                        "enable_close_index" : true,
                        "monitoring_collection_interval" : 0,
                        "monitoring_history_duration" : "string",
                        "reindex_whitelist" : [
                           "string"
                        ],
                        "scripting" : {
                           "expressions_enabled" : true,
                           "file" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           },
                           "inline" : null,
                           "mustache_enabled" : true,
                           "painless_enabled" : true,
                           "stored" : null
                        },
                        "use_disk_threshold" : true,
                        "watcher_trigger_engine" : "string"
                     },
                     "user_bundles" : [
                        {
                           "elasticsearch_version" : "string",
                           "name" : "string",
                           "url" : "string"
                        }
                     ],
                     "user_plugins" : [
                        {
                           "elasticsearch_version" : "string",
                           "name" : "string",
                           "url" : "string"
                        }
                     ],
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "instance_configuration_id" : "string",
                  "node_type" : {
                     "data" : true,
                     "ingest" : true,
                     "master" : true,
                     "ml" : true
                  },
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "deployment_template" : {
               "id" : "string",
               "version" : "string"
            },
            "elasticsearch" : null,
            "transient" : {
               "cluster_settings_json" : {},
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "max_snapshot_age" : 0,
                  "max_snapshot_attempts" : 0,
                  "skip_snapshot" : true,
                  "timeout" : 0
               },
               "restore_snapshot" : {
                  "repository_config" : {
                     "raw_settings" : {}
                  },
                  "repository_name" : "string",
                  "restore_payload" : {
                     "indices" : [
                        "string"
                     ],
                     "raw_settings" : {}
                  },
                  "snapshot_name" : "string",
                  "source_cluster_id" : "string",
                  "strategy" : "string"
               },
               "strategy" : {
                  "autodetect" : {},
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         },
         "plan_attempt_id" : "string",
         "plan_attempt_log" : [
            {
               "completed" : "2019-01-01T00:00:00Z",
               "duration_in_millis" : 0,
               "info_log" : [
                  {
                     "delta_in_millis" : 0,
                     "message" : "string",
                     "stage" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z"
                  }
               ],
               "stage" : "string",
               "started" : "2019-01-01T00:00:00Z",
               "status" : "string",
               "step_id" : "string"
            }
         ],
         "plan_attempt_name" : "string",
         "plan_end_time" : "2019-01-01T00:00:00Z",
         "source" : {
            "action" : "string",
            "admin_id" : "string",
            "date" : "2019-01-01T00:00:00Z",
            "facilitator" : "string",
            "remote_addresses" : [
               "string"
            ],
            "user_id" : "string"
         }
      },
      "healthy" : true,
      "history" : [
         null
      ],
      "pending" : null
   },
   "region" : "string",
   "security" : {
      "last_modified" : "2019-01-01T00:00:00Z",
      "roles" : {},
      "users" : [
         {
            "password_hash" : "string",
            "username" : "string"
         }
      ],
      "users_roles" : [
         {
            "roles" : [
               "string"
            ],
            "username" : "string"
         }
      ],
      "version" : 0
   },
   "settings" : {
      "ccs" : {
         "remote_clusters" : {
            "some_property" : {
               "cluster_id" : "string",
               "skip_unavailable" : true
            }
         }
      },
      "curation" : {
         "specs" : [
            {
               "index_pattern" : "string",
               "trigger_interval_seconds" : 0
            }
         ]
      },
      "dedicated_masters_threshold" : 0,
      "ip_filtering" : {
         "rulesets" : [
            "string"
         ]
      },
      "metadata" : {
         "name" : "string"
      },
      "monitoring" : {
         "target_cluster_id" : "string"
      },
      "snapshot" : {
         "cron_expression" : "string",
         "interval" : "string",
         "retention" : {
            "max_age" : "string",
            "snapshots" : 0
         },
         "slm" : true
      }
   },
   "snapshots" : {
      "count" : 0,
      "healthy" : true,
      "latest_end_time" : "2019-01-01T00:00:00Z",
      "latest_status" : "string",
      "latest_successful" : true,
      "latest_successful_end_time" : "2019-01-01T00:00:00Z",
      "recent_success" : true,
      "scheduled_time" : "2019-01-01T00:00:00Z"
   },
   "status" : "string",
   "system_alerts" : [
      {
         "alert_type" : "string",
         "exit_code" : 0,
         "instance_name" : "string",
         "timestamp" : "2019-01-01T00:00:00Z",
         "url" : "string"
      }
   ],
   "topology" : {
      "healthy" : true,
      "instances" : [
         {
            "allocator_id" : "string",
            "container_started" : true,
            "disk" : {
               "disk_space_available" : 0,
               "disk_space_used" : 0,
               "storage_multiplier" : 0.1
            },
            "healthy" : true,
            "instance_configuration" : {
               "id" : "string",
               "name" : "string",
               "resource" : "string"
            },
            "instance_name" : "string",
            "maintenance_mode" : true,
            "memory" : {
               "instance_capacity" : 0,
               "instance_capacity_planned" : 0,
               "memory_pressure" : 0,
               "native_memory_pressure" : 0
            },
            "service_id" : "string",
            "service_roles" : [
               "string"
            ],
            "service_running" : true,
            "service_version" : "string",
            "zone" : "string"
         }
      ]
   }
}

ElasticsearchClusterPlan

The plan for the Elasticsearch cluster.

Properties

cluster_topology (array[ElasticsearchClusterTopologyElement], required)
deployment_template (DeploymentTemplateReference)
Documents which deployment template was used in the creation of this plan
elasticsearch (ElasticsearchConfiguration, required)
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
transient (TransientElasticsearchPlanConfiguration)
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.

Example

{
   "cluster_topology" : [
      {
         "elasticsearch" : {
            "curation" : {
               "from_instance_configuration_id" : "string",
               "to_instance_configuration_id" : "string"
            },
            "docker_image" : "string",
            "enabled_built_in_plugins" : [
               "string"
            ],
            "node_attributes" : {
               "some_property" : "string"
            },
            "system_settings" : {
               "auto_create_index" : true,
               "default_shards_per_index" : 0,
               "destructive_requires_name" : true,
               "enable_close_index" : true,
               "monitoring_collection_interval" : 0,
               "monitoring_history_duration" : "string",
               "reindex_whitelist" : [
                  "string"
               ],
               "scripting" : {
                  "expressions_enabled" : true,
                  "file" : {
                     "enabled" : true,
                     "sandbox_mode" : true
                  },
                  "inline" : null,
                  "mustache_enabled" : true,
                  "painless_enabled" : true,
                  "stored" : null
               },
               "use_disk_threshold" : true,
               "watcher_trigger_engine" : "string"
            },
            "user_bundles" : [
               {
                  "elasticsearch_version" : "string",
                  "name" : "string",
                  "url" : "string"
               }
            ],
            "user_plugins" : [
               {
                  "elasticsearch_version" : "string",
                  "name" : "string",
                  "url" : "string"
               }
            ],
            "user_settings_json" : {},
            "user_settings_override_json" : {},
            "user_settings_override_yaml" : "string",
            "user_settings_yaml" : "string",
            "version" : "string"
         },
         "instance_configuration_id" : "string",
         "node_type" : {
            "data" : true,
            "ingest" : true,
            "master" : true,
            "ml" : true
         },
         "size" : {
            "resource" : "string",
            "value" : 0
         },
         "zone_count" : 0
      }
   ],
   "deployment_template" : {
      "id" : "string",
      "version" : "string"
   },
   "elasticsearch" : null,
   "transient" : {
      "cluster_settings_json" : {},
      "plan_configuration" : {
         "calm_wait_time" : 0,
         "cluster_reboot" : "string",
         "extended_maintenance" : true,
         "max_snapshot_age" : 0,
         "max_snapshot_attempts" : 0,
         "skip_snapshot" : true,
         "timeout" : 0
      },
      "restore_snapshot" : {
         "repository_config" : {
            "raw_settings" : {}
         },
         "repository_name" : "string",
         "restore_payload" : {
            "indices" : [
               "string"
            ],
            "raw_settings" : {}
         },
         "snapshot_name" : "string",
         "source_cluster_id" : "string",
         "strategy" : "string"
      },
      "strategy" : {
         "autodetect" : {},
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   }
}

ElasticsearchClusterPlanInfo

Information about the Elasticsearch cluster plan.

Properties

attempt_end_time (string as date-time)
If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
attempt_start_time (string as date-time)
When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)
healthy (boolean, required)
Either the plan ended successfully, or is not yet completed (and no errors have occurred)
plan (ElasticsearchClusterPlan)
The plan for the Elasticsearch cluster.
plan_attempt_id (string)
A UUID for each plan attempt
plan_attempt_log (array[ClusterPlanStepInfo], required)
plan_attempt_name (string)
A human readable name for each plan attempt, only populated when retrieving plan histories
plan_end_time (string as date-time)
If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
source (ChangeSourceInfo)
Information describing the source that facilitated the plans current state

Example

{
   "attempt_end_time" : "2019-01-01T00:00:00Z",
   "attempt_start_time" : "2019-01-01T00:00:00Z",
   "healthy" : true,
   "plan" : {
      "cluster_topology" : [
         {
            "elasticsearch" : {
               "curation" : {
                  "from_instance_configuration_id" : "string",
                  "to_instance_configuration_id" : "string"
               },
               "docker_image" : "string",
               "enabled_built_in_plugins" : [
                  "string"
               ],
               "node_attributes" : {
                  "some_property" : "string"
               },
               "system_settings" : {
                  "auto_create_index" : true,
                  "default_shards_per_index" : 0,
                  "destructive_requires_name" : true,
                  "enable_close_index" : true,
                  "monitoring_collection_interval" : 0,
                  "monitoring_history_duration" : "string",
                  "reindex_whitelist" : [
                     "string"
                  ],
                  "scripting" : {
                     "expressions_enabled" : true,
                     "file" : {
                        "enabled" : true,
                        "sandbox_mode" : true
                     },
                     "inline" : null,
                     "mustache_enabled" : true,
                     "painless_enabled" : true,
                     "stored" : null
                  },
                  "use_disk_threshold" : true,
                  "watcher_trigger_engine" : "string"
               },
               "user_bundles" : [
                  {
                     "elasticsearch_version" : "string",
                     "name" : "string",
                     "url" : "string"
                  }
               ],
               "user_plugins" : [
                  {
                     "elasticsearch_version" : "string",
                     "name" : "string",
                     "url" : "string"
                  }
               ],
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "instance_configuration_id" : "string",
            "node_type" : {
               "data" : true,
               "ingest" : true,
               "master" : true,
               "ml" : true
            },
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "deployment_template" : {
         "id" : "string",
         "version" : "string"
      },
      "elasticsearch" : null,
      "transient" : {
         "cluster_settings_json" : {},
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "max_snapshot_age" : 0,
            "max_snapshot_attempts" : 0,
            "skip_snapshot" : true,
            "timeout" : 0
         },
         "restore_snapshot" : {
            "repository_config" : {
               "raw_settings" : {}
            },
            "repository_name" : "string",
            "restore_payload" : {
               "indices" : [
                  "string"
               ],
               "raw_settings" : {}
            },
            "snapshot_name" : "string",
            "source_cluster_id" : "string",
            "strategy" : "string"
         },
         "strategy" : {
            "autodetect" : {},
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   },
   "plan_attempt_id" : "string",
   "plan_attempt_log" : [
      {
         "completed" : "2019-01-01T00:00:00Z",
         "duration_in_millis" : 0,
         "info_log" : [
            {
               "delta_in_millis" : 0,
               "message" : "string",
               "stage" : "string",
               "timestamp" : "2019-01-01T00:00:00Z"
            }
         ],
         "stage" : "string",
         "started" : "2019-01-01T00:00:00Z",
         "status" : "string",
         "step_id" : "string"
      }
   ],
   "plan_attempt_name" : "string",
   "plan_end_time" : "2019-01-01T00:00:00Z",
   "source" : {
      "action" : "string",
      "admin_id" : "string",
      "date" : "2019-01-01T00:00:00Z",
      "facilitator" : "string",
      "remote_addresses" : [
         "string"
      ],
      "user_id" : "string"
   }
}

ElasticsearchClusterPlansInfo

Information about the current, pending, and past Elasticsearch cluster plans.

Properties

current (ElasticsearchClusterPlanInfo)
Information about the Elasticsearch cluster plan.
healthy (boolean, required)
Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
history (array[ElasticsearchClusterPlanInfo], required)
pending (ElasticsearchClusterPlanInfo)
Information about the Elasticsearch cluster plan.

Example

{
   "current" : {
      "attempt_end_time" : "2019-01-01T00:00:00Z",
      "attempt_start_time" : "2019-01-01T00:00:00Z",
      "healthy" : true,
      "plan" : {
         "cluster_topology" : [
            {
               "elasticsearch" : {
                  "curation" : {
                     "from_instance_configuration_id" : "string",
                     "to_instance_configuration_id" : "string"
                  },
                  "docker_image" : "string",
                  "enabled_built_in_plugins" : [
                     "string"
                  ],
                  "node_attributes" : {
                     "some_property" : "string"
                  },
                  "system_settings" : {
                     "auto_create_index" : true,
                     "default_shards_per_index" : 0,
                     "destructive_requires_name" : true,
                     "enable_close_index" : true,
                     "monitoring_collection_interval" : 0,
                     "monitoring_history_duration" : "string",
                     "reindex_whitelist" : [
                        "string"
                     ],
                     "scripting" : {
                        "expressions_enabled" : true,
                        "file" : {
                           "enabled" : true,
                           "sandbox_mode" : true
                        },
                        "inline" : null,
                        "mustache_enabled" : true,
                        "painless_enabled" : true,
                        "stored" : null
                     },
                     "use_disk_threshold" : true,
                     "watcher_trigger_engine" : "string"
                  },
                  "user_bundles" : [
                     {
                        "elasticsearch_version" : "string",
                        "name" : "string",
                        "url" : "string"
                     }
                  ],
                  "user_plugins" : [
                     {
                        "elasticsearch_version" : "string",
                        "name" : "string",
                        "url" : "string"
                     }
                  ],
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "instance_configuration_id" : "string",
               "node_type" : {
                  "data" : true,
                  "ingest" : true,
                  "master" : true,
                  "ml" : true
               },
               "size" : {
                  "resource" : "string",
                  "value" : 0
               },
               "zone_count" : 0
            }
         ],
         "deployment_template" : {
            "id" : "string",
            "version" : "string"
         },
         "elasticsearch" : null,
         "transient" : {
            "cluster_settings_json" : {},
            "plan_configuration" : {
               "calm_wait_time" : 0,
               "cluster_reboot" : "string",
               "extended_maintenance" : true,
               "max_snapshot_age" : 0,
               "max_snapshot_attempts" : 0,
               "skip_snapshot" : true,
               "timeout" : 0
            },
            "restore_snapshot" : {
               "repository_config" : {
                  "raw_settings" : {}
               },
               "repository_name" : "string",
               "restore_payload" : {
                  "indices" : [
                     "string"
                  ],
                  "raw_settings" : {}
               },
               "snapshot_name" : "string",
               "source_cluster_id" : "string",
               "strategy" : "string"
            },
            "strategy" : {
               "autodetect" : {},
               "grow_and_shrink" : {},
               "rolling" : {
                  "allow_inline_resize" : true,
                  "group_by" : "string",
                  "shard_init_wait_time" : 0,
                  "skip_synced_flush" : true
               },
               "rolling_grow_and_shrink" : {}
            }
         }
      },
      "plan_attempt_id" : "string",
      "plan_attempt_log" : [
         {
            "completed" : "2019-01-01T00:00:00Z",
            "duration_in_millis" : 0,
            "info_log" : [
               {
                  "delta_in_millis" : 0,
                  "message" : "string",
                  "stage" : "string",
                  "timestamp" : "2019-01-01T00:00:00Z"
               }
            ],
            "stage" : "string",
            "started" : "2019-01-01T00:00:00Z",
            "status" : "string",
            "step_id" : "string"
         }
      ],
      "plan_attempt_name" : "string",
      "plan_end_time" : "2019-01-01T00:00:00Z",
      "source" : {
         "action" : "string",
         "admin_id" : "string",
         "date" : "2019-01-01T00:00:00Z",
         "facilitator" : "string",
         "remote_addresses" : [
            "string"
         ],
         "user_id" : "string"
      }
   },
   "healthy" : true,
   "history" : [
      null
   ],
   "pending" : null
}

ElasticsearchClusterRole

The authorization information for an Elasticsearch cluster user.

Properties

roles (array[string], required)
The list of roles for this user
username (string, required)
The username

Example

{
   "roles" : [
      "string"
   ],
   "username" : "string"
}

ElasticsearchClusterSecurityInfo

For 2.x Elasticsearch clusters, specifies the information about the users and roles. For 5.x Elasticsearch clusters, use the Kibana management UI.

Properties

last_modified (string as date-time, required)
The most recent time the security settings were changed (ISO format in UTC)
roles (object, required)
An arbitrarily nested JSON object mapping roles to sets of resources and permissions - see the Elasticsearch security documentation for more details on roles
users (array[ElasticsearchClusterUser], required)
users_roles (array[ElasticsearchClusterRole], required)
version (integer as int32, required)
The resource version number of the security settings

Example

{
   "last_modified" : "2019-01-01T00:00:00Z",
   "roles" : {},
   "users" : [
      {
         "password_hash" : "string",
         "username" : "string"
      }
   ],
   "users_roles" : [
      {
         "roles" : [
            "string"
         ],
         "username" : "string"
      }
   ],
   "version" : 0
}

ElasticsearchClusterSettings

The settings for an Elasticsearch cluster.

Properties

ccs (CrossClusterSearchSettings)
The configuration settings for the cross-cluster search.
curation (ClusterCurationSettings)
The index curation settings for an Elasticsearch cluster.
dedicated_masters_threshold (integer as int32)
Threshold starting from which the number of instances in the cluster results in the introduction of dedicated masters. If the cluster is downscaled to a number of nodes below this one, dedicated masters will be removed. Limit is inclusive.
ip_filtering (IpFilteringSettings)
The set of rulesets to apply for all the resources in this cluster. When specified the same rulesets will be applied to Kibana and APM clusters as well
metadata (ClusterMetadataSettings)
The top-level configuration settings for the Elasticsearch cluster.
monitoring (ManagedMonitoringSettings)
The settings for sending monitoring information to another cluster.
snapshot (ClusterSnapshotSettings)
The snapshot configuration settings for an Elasticsearch cluster.

Example

{
   "ccs" : {
      "remote_clusters" : {
         "some_property" : {
            "cluster_id" : "string",
            "skip_unavailable" : true
         }
      }
   },
   "curation" : {
      "specs" : [
         {
            "index_pattern" : "string",
            "trigger_interval_seconds" : 0
         }
      ]
   },
   "dedicated_masters_threshold" : 0,
   "ip_filtering" : {
      "rulesets" : [
         "string"
      ]
   },
   "metadata" : {
      "name" : "string"
   },
   "monitoring" : {
      "target_cluster_id" : "string"
   },
   "snapshot" : {
      "cron_expression" : "string",
      "interval" : "string",
      "retention" : {
         "max_age" : "string",
         "snapshots" : 0
      },
      "slm" : true
   }
}

ElasticsearchClusterTopologyElement

The topology of the Elasticsearch nodes, including the number, capacity, and type of nodes, and where they can be allocated.

Properties

elasticsearch (ElasticsearchConfiguration)
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
instance_configuration_id (string)
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
node_type (ElasticsearchNodeType)
Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.
size (TopologySize)
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
zone_count (integer as int32)
The default number of zones in which data nodes will be placed

Example

{
   "elasticsearch" : {
      "curation" : {
         "from_instance_configuration_id" : "string",
         "to_instance_configuration_id" : "string"
      },
      "docker_image" : "string",
      "enabled_built_in_plugins" : [
         "string"
      ],
      "node_attributes" : {
         "some_property" : "string"
      },
      "system_settings" : {
         "auto_create_index" : true,
         "default_shards_per_index" : 0,
         "destructive_requires_name" : true,
         "enable_close_index" : true,
         "monitoring_collection_interval" : 0,
         "monitoring_history_duration" : "string",
         "reindex_whitelist" : [
            "string"
         ],
         "scripting" : {
            "expressions_enabled" : true,
            "file" : {
               "enabled" : true,
               "sandbox_mode" : true
            },
            "inline" : null,
            "mustache_enabled" : true,
            "painless_enabled" : true,
            "stored" : null
         },
         "use_disk_threshold" : true,
         "watcher_trigger_engine" : "string"
      },
      "user_bundles" : [
         {
            "elasticsearch_version" : "string",
            "name" : "string",
            "url" : "string"
         }
      ],
      "user_plugins" : [
         {
            "elasticsearch_version" : "string",
            "name" : "string",
            "url" : "string"
         }
      ],
      "user_settings_json" : {},
      "user_settings_override_json" : {},
      "user_settings_override_yaml" : "string",
      "user_settings_yaml" : "string",
      "version" : "string"
   },
   "instance_configuration_id" : "string",
   "node_type" : {
      "data" : true,
      "ingest" : true,
      "master" : true,
      "ml" : true
   },
   "size" : {
      "resource" : "string",
      "value" : 0
   },
   "zone_count" : 0
}

ElasticsearchClusterUser

The information about an Elasticsearch cluster user.

Properties

password_hash (string, required)
The hashed password
username (string, required)
The username

Example

{
   "password_hash" : "string",
   "username" : "string"
}

ElasticsearchConfiguration

The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

Properties

curation (ElasticsearchCuration)
Defines the index curation routing for the cluster
docker_image (string)
A docker URI that allows overriding of the default docker image specified for this version
enabled_built_in_plugins (array[string])
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
node_attributes (map[string,string])
Defines the Elasticsearch node attributes for the instances in the topology
system_settings (ElasticsearchSystemSettings)
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.
user_bundles (array[ElasticsearchUserBundle])
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
user_plugins (array[ElasticsearchUserPlugin])
A list of admin-uploaded plugin objects that are available for this user.
user_settings_json (object)
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
user_settings_override_json (object)
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
user_settings_override_yaml (string)
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
user_settings_yaml (string)
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
version (string)
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals)

Example

{
   "curation" : {
      "from_instance_configuration_id" : "string",
      "to_instance_configuration_id" : "string"
   },
   "docker_image" : "string",
   "enabled_built_in_plugins" : [
      "string"
   ],
   "node_attributes" : {
      "some_property" : "string"
   },
   "system_settings" : {
      "auto_create_index" : true,
      "default_shards_per_index" : 0,
      "destructive_requires_name" : true,
      "enable_close_index" : true,
      "monitoring_collection_interval" : 0,
      "monitoring_history_duration" : "string",
      "reindex_whitelist" : [
         "string"
      ],
      "scripting" : {
         "expressions_enabled" : true,
         "file" : {
            "enabled" : true,
            "sandbox_mode" : true
         },
         "inline" : null,
         "mustache_enabled" : true,
         "painless_enabled" : true,
         "stored" : null
      },
      "use_disk_threshold" : true,
      "watcher_trigger_engine" : "string"
   },
   "user_bundles" : [
      {
         "elasticsearch_version" : "string",
         "name" : "string",
         "url" : "string"
      }
   ],
   "user_plugins" : [
      {
         "elasticsearch_version" : "string",
         "name" : "string",
         "url" : "string"
      }
   ],
   "user_settings_json" : {},
   "user_settings_override_json" : {},
   "user_settings_override_yaml" : "string",
   "user_settings_yaml" : "string",
   "version" : "string"
}

ElasticsearchCuration

The structure that defines the routing settings for index curation.

Properties

from_instance_configuration_id (string, required)
The source instance configuration
to_instance_configuration_id (string, required)
The destination instance configuration

Example

{
   "from_instance_configuration_id" : "string",
   "to_instance_configuration_id" : "string"
}

ElasticsearchDependant

Details about an orphaned Elasticsearch-dependent resources.

Properties

id (string, required)
The id of the orphaned resource
kind (string, required)
The kind of resource

Example

{
   "id" : "string",
   "kind" : "string"
}

ElasticsearchElasticUserPasswordResetResponse

Envelope holding the newly-reset password for a cluster's elasticsearch user

Properties

password (string, required)
The newly-reset password for the given Elasticsearch cluster

Example

{
   "password" : "string"
}

ElasticsearchInfo

Information about the Elasticsearch cluster.

Properties

blocking_issues (ElasticsearchClusterBlockingIssues, required)
Issues that prevent the Elasticsearch cluster or index from correctly operating.
healthy (boolean, required)
Whether the Elasticsearch cluster is healthy (check the sub-objects for more details if not)
master_info (ElasticsearchMasterInfo, required)
Information about the master nodes in the Elasticsearch cluster.
shard_info (ElasticsearchShardsInfo, required)
Information about the shards and replicas that comprise the Elasticsearch indices.

Example

{
   "blocking_issues" : {
      "cluster_level" : [
         {
            "description" : "string",
            "instances" : [
               "string"
            ]
         }
      ],
      "healthy" : true,
      "index_level" : [
         null
      ]
   },
   "healthy" : true,
   "master_info" : {
      "healthy" : true,
      "instances_with_no_master" : [
         "string"
      ],
      "masters" : [
         {
            "instances" : [
               "string"
            ],
            "master_instance_name" : "string",
            "master_node_id" : "string"
         }
      ]
   },
   "shard_info" : {
      "available_shards" : [
         {
            "instance_name" : "string",
            "shard_count" : 0
         }
      ],
      "healthy" : true,
      "unavailable_replicas" : [
         {
            "instance_name" : "string",
            "replica_count" : 0
         }
      ],
      "unavailable_shards" : [
         null
      ]
   }
}

ElasticsearchMasterElement

Information about the Elasticsearch instances. For split-brain cases, this also includes sub-clusters.

Properties

instances (array[string], required)
The names of the instance/container hosting the node belong to the cluster with the given master
master_instance_name (string)
The corresponding instance name of the container hosting the Elasticsearch master node, if available
master_node_id (string, required)
The Elasticsearch node id of a master node

Example

{
   "instances" : [
      "string"
   ],
   "master_instance_name" : "string",
   "master_node_id" : "string"
}

ElasticsearchMasterInfo

Information about the master nodes in the Elasticsearch cluster.

Properties

healthy (boolean, required)
Whether the master situation in the cluster is healthy (ie is the number of masters != 1), or do any instances have no master
instances_with_no_master (array[string], required)
A list of any instances with no master
masters (array[ElasticsearchMasterElement], required)

Example

{
   "healthy" : true,
   "instances_with_no_master" : [
      "string"
   ],
   "masters" : [
      {
         "instances" : [
            "string"
         ],
         "master_instance_name" : "string",
         "master_node_id" : "string"
      }
   ]
}

ElasticsearchMonitoringInfo

Information about the monitoring status for the Elasticsearch cluster.

Properties

destination_cluster_ids (array[string], required)
The list of clusters Ids to which this cluster is currently sending monitoring data
healthy (boolean, required)
Whether the Monitoring configuration has been successfully applied
last_modified (string as date-time, required)
The time the monitoring configuration was last changed
last_update_status (string, required)
The status message from the last update (successful or not)
source_cluster_ids (array[string], required)
The list of clusters Ids from which this cluster is currently receiving monitoring data

Example

{
   "destination_cluster_ids" : [
      "string"
   ],
   "healthy" : true,
   "last_modified" : "2019-01-01T00:00:00Z",
   "last_update_status" : "string",
   "source_cluster_ids" : [
      "string"
   ]
}

ElasticsearchNodeType

Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.

Properties

data (boolean)
Defines whether this node can hold data (default: true)
ingest (boolean)
Defines whether this node can run an ingest pipeline (default: true)
master (boolean)
Defines whether this node can be elected master (default: true)
ml (boolean)
Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)

Example

{
   "data" : true,
   "ingest" : true,
   "master" : true,
   "ml" : true
}

ElasticsearchPayload

An alias for an Elasticsearch Cluster paired with a request for creating one

Properties

display_name (string)
The human readable name for the cluster (defaults to the generated cluster id if not specified)
plan (ElasticsearchClusterPlan, required)
The plan for building this Elasticsearch cluster
ref_id (string, required)
A locally-unique user-specified id for this Elasticsearch cluster
region (string, required)
The region where this resource exists
settings (ElasticsearchClusterSettings)
The settings for building this Elasticsearch cluster

Example

{
   "display_name" : "string",
   "plan" : {
      "cluster_topology" : [
         {
            "elasticsearch" : {
               "curation" : {
                  "from_instance_configuration_id" : "string",
                  "to_instance_configuration_id" : "string"
               },
               "docker_image" : "string",
               "enabled_built_in_plugins" : [
                  "string"
               ],
               "node_attributes" : {
                  "some_property" : "string"
               },
               "system_settings" : {
                  "auto_create_index" : true,
                  "default_shards_per_index" : 0,
                  "destructive_requires_name" : true,
                  "enable_close_index" : true,
                  "monitoring_collection_interval" : 0,
                  "monitoring_history_duration" : "string",
                  "reindex_whitelist" : [
                     "string"
                  ],
                  "scripting" : {
                     "expressions_enabled" : true,
                     "file" : {
                        "enabled" : true,
                        "sandbox_mode" : true
                     },
                     "inline" : null,
                     "mustache_enabled" : true,
                     "painless_enabled" : true,
                     "stored" : null
                  },
                  "use_disk_threshold" : true,
                  "watcher_trigger_engine" : "string"
               },
               "user_bundles" : [
                  {
                     "elasticsearch_version" : "string",
                     "name" : "string",
                     "url" : "string"
                  }
               ],
               "user_plugins" : [
                  {
                     "elasticsearch_version" : "string",
                     "name" : "string",
                     "url" : "string"
                  }
               ],
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "instance_configuration_id" : "string",
            "node_type" : {
               "data" : true,
               "ingest" : true,
               "master" : true,
               "ml" : true
            },
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "deployment_template" : {
         "id" : "string",
         "version" : "string"
      },
      "elasticsearch" : null,
      "transient" : {
         "cluster_settings_json" : {},
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "max_snapshot_age" : 0,
            "max_snapshot_attempts" : 0,
            "skip_snapshot" : true,
            "timeout" : 0
         },
         "restore_snapshot" : {
            "repository_config" : {
               "raw_settings" : {}
            },
            "repository_name" : "string",
            "restore_payload" : {
               "indices" : [
                  "string"
               ],
               "raw_settings" : {}
            },
            "snapshot_name" : "string",
            "source_cluster_id" : "string",
            "strategy" : "string"
         },
         "strategy" : {
            "autodetect" : {},
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   },
   "ref_id" : "string",
   "region" : "string",
   "settings" : {
      "ccs" : {
         "remote_clusters" : {
            "some_property" : {
               "cluster_id" : "string",
               "skip_unavailable" : true
            }
         }
      },
      "curation" : {
         "specs" : [
            {
               "index_pattern" : "string",
               "trigger_interval_seconds" : 0
            }
         ]
      },
      "dedicated_masters_threshold" : 0,
      "ip_filtering" : {
         "rulesets" : [
            "string"
         ]
      },
      "metadata" : {
         "name" : "string"
      },
      "monitoring" : {
         "target_cluster_id" : "string"
      },
      "snapshot" : {
         "cron_expression" : "string",
         "interval" : "string",
         "retention" : {
            "max_age" : "string",
            "snapshots" : 0
         },
         "slm" : true
      }
   }
}

ElasticsearchPlanControlConfiguration

The configuration settings for the timeout and fallback parameters.

Properties

calm_wait_time (integer as int64)
This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
cluster_reboot (string; allowed values: [forced])
Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)
extended_maintenance (boolean)
If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
max_snapshot_age (integer as int64)
When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300
max_snapshot_attempts (integer as int32)
If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)
skip_snapshot (boolean)
If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster
timeout (integer as int64)
The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: (eg a 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds)

Example

{
   "calm_wait_time" : 0,
   "cluster_reboot" : "string",
   "extended_maintenance" : true,
   "max_snapshot_age" : 0,
   "max_snapshot_attempts" : 0,
   "skip_snapshot" : true,
   "timeout" : 0
}

ElasticsearchReplicaElement

Information about the unavailable replicas. NOTE: Unlike shards, unavailable replicas indicate a loss of redundancy rather than a loss of availability.

Properties

instance_name (string, required)
The Elastic Cloud name/id of the instance (container)
replica_count (integer as int32, required)
The number of unavailable replicas on this instance

Example

{
   "instance_name" : "string",
   "replica_count" : 0
}

ElasticsearchResourceInfo

Describes an Elasticsearch resource belonging to a Deployment

Properties

id (string, required)
The randomly-generated id of a Resource
info (ElasticsearchClusterInfo, required)
Info for the resource.
ref_id (string, required)
The locally-unique user-specified id of a Resource
region (string, required)
The region where this resource exists

Example

{
   "id" : "string",
   "info" : {
      "associated_apm_clusters" : [
         {
            "apm_id" : "string",
            "enabled" : true,
            "links" : {
               "some_property" : {
                  "need_elevated_permissions" : true
               }
            }
         }
      ],
      "associated_appsearch_clusters" : [
         {
            "app_search_id" : "string",
            "enabled" : true,
            "links" : {
               "some_property" : null
            }
         }
      ],
      "associated_enterprise_search_clusters" : [
         {
            "enabled" : true,
            "enterprise_search_id" : "string",
            "links" : {
               "some_property" : null
            }
         }
      ],
      "associated_kibana_clusters" : [
         {
            "enabled" : true,
            "kibana_id" : "string",
            "links" : {
               "some_property" : null
            }
         }
      ],
      "ccs" : {
         "healthy" : true,
         "remote_clusters" : [
            {
               "compatible" : true,
               "id" : "string",
               "version" : "string"
            }
         ]
      },
      "cluster_id" : "string",
      "cluster_name" : "string",
      "deployment_id" : "string",
      "elasticsearch" : {
         "blocking_issues" : {
            "cluster_level" : [
               {
                  "description" : "string",
                  "instances" : [
                     "string"
                  ]
               }
            ],
            "healthy" : true,
            "index_level" : [
               null
            ]
         },
         "healthy" : true,
         "master_info" : {
            "healthy" : true,
            "instances_with_no_master" : [
               "string"
            ],
            "masters" : [
               {
                  "instances" : [
                     "string"
                  ],
                  "master_instance_name" : "string",
                  "master_node_id" : "string"
               }
            ]
         },
         "shard_info" : {
            "available_shards" : [
               {
                  "instance_name" : "string",
                  "shard_count" : 0
               }
            ],
            "healthy" : true,
            "unavailable_replicas" : [
               {
                  "instance_name" : "string",
                  "replica_count" : 0
               }
            ],
            "unavailable_shards" : [
               null
            ]
         }
      },
      "elasticsearch_monitoring_info" : {
         "destination_cluster_ids" : [
            "string"
         ],
         "healthy" : true,
         "last_modified" : "2019-01-01T00:00:00Z",
         "last_update_status" : "string",
         "source_cluster_ids" : [
            "string"
         ]
      },
      "external_links" : [
         {
            "id" : "string",
            "label" : "string",
            "uri" : "string"
         }
      ],
      "healthy" : true,
      "links" : {
         "some_property" : null
      },
      "metadata" : {
         "cloud_id" : "string",
         "endpoint" : "string",
         "last_modified" : "2019-01-01T00:00:00Z",
         "ports" : {
            "http" : 0,
            "https" : 0
         },
         "raw" : {},
         "version" : 0
      },
      "plan_info" : {
         "current" : {
            "attempt_end_time" : "2019-01-01T00:00:00Z",
            "attempt_start_time" : "2019-01-01T00:00:00Z",
            "healthy" : true,
            "plan" : {
               "cluster_topology" : [
                  {
                     "elasticsearch" : {
                        "curation" : {
                           "from_instance_configuration_id" : "string",
                           "to_instance_configuration_id" : "string"
                        },
                        "docker_image" : "string",
                        "enabled_built_in_plugins" : [
                           "string"
                        ],
                        "node_attributes" : {
                           "some_property" : "string"
                        },
                        "system_settings" : {
                           "auto_create_index" : true,
                           "default_shards_per_index" : 0,
                           "destructive_requires_name" : true,
                           "enable_close_index" : true,
                           "monitoring_collection_interval" : 0,
                           "monitoring_history_duration" : "string",
                           "reindex_whitelist" : [
                              "string"
                           ],
                           "scripting" : {
                              "expressions_enabled" : true,
                              "file" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              },
                              "inline" : null,
                              "mustache_enabled" : true,
                              "painless_enabled" : true,
                              "stored" : null
                           },
                           "use_disk_threshold" : true,
                           "watcher_trigger_engine" : "string"
                        },
                        "user_bundles" : [
                           {
                              "elasticsearch_version" : "string",
                              "name" : "string",
                              "url" : "string"
                           }
                        ],
                        "user_plugins" : [
                           {
                              "elasticsearch_version" : "string",
                              "name" : "string",
                              "url" : "string"
                           }
                        ],
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "instance_configuration_id" : "string",
                     "node_type" : {
                        "data" : true,
                        "ingest" : true,
                        "master" : true,
                        "ml" : true
                     },
                     "size" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "zone_count" : 0
                  }
               ],
               "deployment_template" : {
                  "id" : "string",
                  "version" : "string"
               },
               "elasticsearch" : null,
               "transient" : {
                  "cluster_settings_json" : {},
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "max_snapshot_age" : 0,
                     "max_snapshot_attempts" : 0,
                     "skip_snapshot" : true,
                     "timeout" : 0
                  },
                  "restore_snapshot" : {
                     "repository_config" : {
                        "raw_settings" : {}
                     },
                     "repository_name" : "string",
                     "restore_payload" : {
                        "indices" : [
                           "string"
                        ],
                        "raw_settings" : {}
                     },
                     "snapshot_name" : "string",
                     "source_cluster_id" : "string",
                     "strategy" : "string"
                  },
                  "strategy" : {
                     "autodetect" : {},
                     "grow_and_shrink" : {},
                     "rolling" : {
                        "allow_inline_resize" : true,
                        "group_by" : "string",
                        "shard_init_wait_time" : 0,
                        "skip_synced_flush" : true
                     },
                     "rolling_grow_and_shrink" : {}
                  }
               }
            },
            "plan_attempt_id" : "string",
            "plan_attempt_log" : [
               {
                  "completed" : "2019-01-01T00:00:00Z",
                  "duration_in_millis" : 0,
                  "info_log" : [
                     {
                        "delta_in_millis" : 0,
                        "message" : "string",
                        "stage" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     }
                  ],
                  "stage" : "string",
                  "started" : "2019-01-01T00:00:00Z",
                  "status" : "string",
                  "step_id" : "string"
               }
            ],
            "plan_attempt_name" : "string",
            "plan_end_time" : "2019-01-01T00:00:00Z",
            "source" : {
               "action" : "string",
               "admin_id" : "string",
               "date" : "2019-01-01T00:00:00Z",
               "facilitator" : "string",
               "remote_addresses" : [
                  "string"
               ],
               "user_id" : "string"
            }
         },
         "healthy" : true,
         "history" : [
            null
         ],
         "pending" : null
      },
      "region" : "string",
      "security" : {
         "last_modified" : "2019-01-01T00:00:00Z",
         "roles" : {},
         "users" : [
            {
               "password_hash" : "string",
               "username" : "string"
            }
         ],
         "users_roles" : [
            {
               "roles" : [
                  "string"
               ],
               "username" : "string"
            }
         ],
         "version" : 0
      },
      "settings" : {
         "ccs" : {
            "remote_clusters" : {
               "some_property" : {
                  "cluster_id" : "string",
                  "skip_unavailable" : true
               }
            }
         },
         "curation" : {
            "specs" : [
               {
                  "index_pattern" : "string",
                  "trigger_interval_seconds" : 0
               }
            ]
         },
         "dedicated_masters_threshold" : 0,
         "ip_filtering" : {
            "rulesets" : [
               "string"
            ]
         },
         "metadata" : {
            "name" : "string"
         },
         "monitoring" : {
            "target_cluster_id" : "string"
         },
         "snapshot" : {
            "cron_expression" : "string",
            "interval" : "string",
            "retention" : {
               "max_age" : "string",
               "snapshots" : 0
            },
            "slm" : true
         }
      },
      "snapshots" : {
         "count" : 0,
         "healthy" : true,
         "latest_end_time" : "2019-01-01T00:00:00Z",
         "latest_status" : "string",
         "latest_successful" : true,
         "latest_successful_end_time" : "2019-01-01T00:00:00Z",
         "recent_success" : true,
         "scheduled_time" : "2019-01-01T00:00:00Z"
      },
      "status" : "string",
      "system_alerts" : [
         {
            "alert_type" : "string",
            "exit_code" : 0,
            "instance_name" : "string",
            "timestamp" : "2019-01-01T00:00:00Z",
            "url" : "string"
         }
      ],
      "topology" : {
         "healthy" : true,
         "instances" : [
            {
               "allocator_id" : "string",
               "container_started" : true,
               "disk" : {
                  "disk_space_available" : 0,
                  "disk_space_used" : 0,
                  "storage_multiplier" : 0.1
               },
               "healthy" : true,
               "instance_configuration" : {
                  "id" : "string",
                  "name" : "string",
                  "resource" : "string"
               },
               "instance_name" : "string",
               "maintenance_mode" : true,
               "memory" : {
                  "instance_capacity" : 0,
                  "instance_capacity_planned" : 0,
                  "memory_pressure" : 0,
                  "native_memory_pressure" : 0
               },
               "service_id" : "string",
               "service_roles" : [
                  "string"
               ],
               "service_running" : true,
               "service_version" : "string",
               "zone" : "string"
            }
         ]
      }
   },
   "ref_id" : "string",
   "region" : "string"
}

ElasticsearchScriptTypeSettings

Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

Properties

enabled (boolean)
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
sandbox_mode (boolean)
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')

Example

{
   "enabled" : true,
   "sandbox_mode" : true
}

ElasticsearchScriptingUserSettings

Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.

Properties

expressions_enabled (boolean)
(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
file (ElasticsearchScriptTypeSettings)
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
inline (ElasticsearchScriptTypeSettings)
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).
mustache_enabled (boolean)
(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
painless_enabled (boolean)
(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
stored (ElasticsearchScriptTypeSettings)
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (stored), upload in file bundles (file), or use in API requests (inline).

Example

{
   "expressions_enabled" : true,
   "file" : {
      "enabled" : true,
      "sandbox_mode" : true
   },
   "inline" : null,
   "mustache_enabled" : true,
   "painless_enabled" : true,
   "stored" : null
}

ElasticsearchShardElement

Information about the shards for each Elasticsearch instance container that hosts an Elasticsearch node. TIP: When the shard is unavailable, the cluster is unable to serve all of the data.

Properties

instance_name (string, required)
The Elastic Cloud name/id of the instance (container)
shard_count (integer as int32, required)
The number of shards of the given type (available/unavailable) on this instance

Example

{
   "instance_name" : "string",
   "shard_count" : 0
}

ElasticsearchShardsInfo

Information about the shards and replicas that comprise the Elasticsearch indices.

Properties

available_shards (array[ElasticsearchShardElement], required)
healthy (boolean, required)
Whether the shard situation is healthy (any unavailable shards is unhealthy)
unavailable_replicas (array[ElasticsearchReplicaElement], required)
unavailable_shards (array[ElasticsearchShardElement], required)

Example

{
   "available_shards" : [
      {
         "instance_name" : "string",
         "shard_count" : 0
      }
   ],
   "healthy" : true,
   "unavailable_replicas" : [
      {
         "instance_name" : "string",
         "replica_count" : 0
      }
   ],
   "unavailable_shards" : [
      null
   ]
}

ElasticsearchSystemSettings

A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use ElasticsearchSystemSettings with user_settings_override* and user_settings*.

Properties

auto_create_index (boolean)
If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
default_shards_per_index (integer as int32)
(2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
destructive_requires_name (boolean)
If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
enable_close_index (boolean)
Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
monitoring_collection_interval (integer as int32)
The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
monitoring_history_duration (string)
The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
reindex_whitelist (array[string])
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
scripting (ElasticsearchScriptingUserSettings)
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
use_disk_threshold (boolean)
Whether to factor in the available disk space on a node before deciding whether to allocate new shards to that node or actively relocate shards away from the node (default: true). NOTES: (Corresponds to the parameter 'cluster.routing.allocation.disk.threshold_enabled')
watcher_trigger_engine (string)
The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)

Example

{
   "auto_create_index" : true,
   "default_shards_per_index" : 0,
   "destructive_requires_name" : true,
   "enable_close_index" : true,
   "monitoring_collection_interval" : 0,
   "monitoring_history_duration" : "string",
   "reindex_whitelist" : [
      "string"
   ],
   "scripting" : {
      "expressions_enabled" : true,
      "file" : {
         "enabled" : true,
         "sandbox_mode" : true
      },
      "inline" : null,
      "mustache_enabled" : true,
      "painless_enabled" : true,
      "stored" : null
   },
   "use_disk_threshold" : true,
   "watcher_trigger_engine" : "string"
}

ElasticsearchUserBundle

A list of admin-uploaded bundle objects, such as scripts and synonym files.

Properties

elasticsearch_version (string, required)
The supported Elasticsearch version (must match the version in the plan)
name (string, required)
The name of the bundle
url (string, required)
The URL of the bundle (must be accessible from the ECE infrastructure)

Example

{
   "elasticsearch_version" : "string",
   "name" : "string",
   "url" : "string"
}

ElasticsearchUserPlugin

A list of admin-uploaded plugin objects.

Properties

elasticsearch_version (string, required)
The supported Elasticsearch version (must match the version in the plan)
name (string, required)
The name of the plugin
url (string, required)
The URL of the plugin (must be accessible from the ECE infrastructure)

Example

{
   "elasticsearch_version" : "string",
   "name" : "string",
   "url" : "string"
}

EnableIlmRequest

Request sent to enable ILM on a deployment.

Properties

index_patterns (array[IndexPattern], required)
A locally-unique user-specified id for Kibana

Example

{
   "index_patterns" : [
      {
         "index_pattern" : "string",
         "node_attributes" : {
            "some_property" : "string"
         },
         "policy_name" : "string"
      }
   ]
}

EnterpriseSearch

Holds diagnostics for an Enterprise Search resource

Properties

backend_plan (object, required)
The backend plan as JSON
display_name (string, required)
The human readable name (defaults to the generated cluster id if not specified)
elasticsearch_cluster_ref_id (string, required)
The user-specified id of the Elasticsearch Cluster that this will link to
ref_id (string, required)
A locally-unique user-specified id

Example

{
   "backend_plan" : {},
   "display_name" : "string",
   "elasticsearch_cluster_ref_id" : "string",
   "ref_id" : "string"
}

EnterpriseSearchConfiguration

Intentionally left blank

Properties

docker_image (string)
A docker URI that allows overriding of the default docker image specified for this version
system_settings (EnterpriseSearchSystemSettings)
This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override_' and 'user_settings_' defines the total set of Enterprise Search settings)
user_settings_json (object)
An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
user_settings_override_json (object)
An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
user_settings_override_yaml (string)
An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings)
user_settings_yaml (string)
An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings)
version (string)
The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

Example

{
   "docker_image" : "string",
   "system_settings" : {
      "elasticsearch_password" : "string",
      "elasticsearch_url" : "string",
      "elasticsearch_username" : "string",
      "secret_session_key" : "string"
   },
   "user_settings_json" : {},
   "user_settings_override_json" : {},
   "user_settings_override_yaml" : "string",
   "user_settings_yaml" : "string",
   "version" : "string"
}

EnterpriseSearchInfo

The overview information for the Enterprise Search Server.

Properties

deployment_id (string)
The id of the deployment that this Enterprise Search belongs to.
elasticsearch_cluster (TargetElasticsearchCluster, required)
Information about the specified Elasticsearch cluster.
external_links (array[ExternalHyperlink], required)
External resources related to the Enterprise Search
healthy (boolean, required)
Whether the Enterprise Search is healthy or not (one or more of the info subsections will have healthy: false)
id (string, required)
The id of the Enterprise Search
links (map[string,Hyperlink])
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
metadata (ClusterMetadataInfo)
Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.
name (string, required)
The name of the Enterprise Search
plan_info (EnterpriseSearchPlansInfo, required)
Information about current, pending, and past Enterprise Search Server plans.
region (string)
The region that this Enterprise Search belongs to. Only populated in SaaS or federated ECE.
settings (EnterpriseSearchSettings)
The cluster metadata settings for the Enterprise Search
status (string; allowed values: [initializing, stopping, stopped, rebooting, restarting, reconfiguring, started], required)
Enterprise Search status
topology (ClusterTopologyInfo, required)
The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.

Example

{
   "deployment_id" : "string",
   "elasticsearch_cluster" : {
      "elasticsearch_id" : "string",
      "links" : {
         "some_property" : {
            "need_elevated_permissions" : true
         }
      }
   },
   "external_links" : [
      {
         "id" : "string",
         "label" : "string",
         "uri" : "string"
      }
   ],
   "healthy" : true,
   "id" : "string",
   "links" : {
      "some_property" : null
   },
   "metadata" : {
      "cloud_id" : "string",
      "endpoint" : "string",
      "last_modified" : "2019-01-01T00:00:00Z",
      "ports" : {
         "http" : 0,
         "https" : 0
      },
      "raw" : {},
      "version" : 0
   },
   "name" : "string",
   "plan_info" : {
      "current" : {
         "attempt_end_time" : "2019-01-01T00:00:00Z",
         "attempt_start_time" : "2019-01-01T00:00:00Z",
         "healthy" : true,
         "plan" : {
            "cluster_topology" : [
               {
                  "allocator_filter" : {},
                  "enterprise_search" : {
                     "docker_image" : "string",
                     "system_settings" : {
                        "elasticsearch_password" : "string",
                        "elasticsearch_url" : "string",
                        "elasticsearch_username" : "string",
                        "secret_session_key" : "string"
                     },
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "instance_configuration_id" : "string",
                  "memory_per_node" : {},
                  "node_configuration" : "string",
                  "node_count_per_zone" : {},
                  "node_type" : {
                     "appserver" : true,
                     "connector" : true,
                     "worker" : true
                  },
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "enterprise_search" : null,
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "move_allocators" : [
                     {
                        "allocator_down" : true,
                        "from" : "string",
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "move_instances" : [
                     {
                        "from" : "string",
                        "instance_down" : true,
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "timeout" : 0
               },
               "strategy" : {
                  "autodetect" : {},
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         },
         "plan_attempt_id" : "string",
         "plan_attempt_log" : [
            {
               "completed" : "2019-01-01T00:00:00Z",
               "duration_in_millis" : 0,
               "info_log" : [
                  {
                     "delta_in_millis" : 0,
                     "message" : "string",
                     "stage" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z"
                  }
               ],
               "stage" : "string",
               "started" : "2019-01-01T00:00:00Z",
               "status" : "string",
               "step_id" : "string"
            }
         ],
         "plan_attempt_name" : "string",
         "plan_end_time" : "2019-01-01T00:00:00Z",
         "source" : {
            "action" : "string",
            "admin_id" : "string",
            "date" : "2019-01-01T00:00:00Z",
            "facilitator" : "string",
            "remote_addresses" : [
               "string"
            ],
            "user_id" : "string"
         }
      },
      "healthy" : true,
      "history" : [
         null
      ],
      "pending" : null
   },
   "region" : "string",
   "settings" : {
      "metadata" : {
         "name" : "string"
      }
   },
   "status" : "string",
   "topology" : {
      "healthy" : true,
      "instances" : [
         {
            "allocator_id" : "string",
            "container_started" : true,
            "disk" : {
               "disk_space_available" : 0,
               "disk_space_used" : 0,
               "storage_multiplier" : 0.1
            },
            "healthy" : true,
            "instance_configuration" : {
               "id" : "string",
               "name" : "string",
               "resource" : "string"
            },
            "instance_name" : "string",
            "maintenance_mode" : true,
            "memory" : {
               "instance_capacity" : 0,
               "instance_capacity_planned" : 0,
               "memory_pressure" : 0,
               "native_memory_pressure" : 0
            },
            "service_id" : "string",
            "service_roles" : [
               "string"
            ],
            "service_running" : true,
            "service_version" : "string",
            "zone" : "string"
         }
      ]
   }
}

EnterpriseSearchNodeTypes

Node types to enable for an Enterprise Search instance

Properties

appserver (boolean, required)
Defines whether this instance should run as Application/API server
connector (boolean, required)
Defines whether this instance should run as Connector
worker (boolean, required)
Defines whether this instance should run as background worker

Example

{
   "appserver" : true,
   "connector" : true,
   "worker" : true
}

EnterpriseSearchPlan

Intentionally left blank

Properties

cluster_topology (array[EnterpriseSearchTopologyElement])
enterprise_search (EnterpriseSearchConfiguration, required)
transient (TransientEnterpriseSearchPlanConfiguration)
Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied

Example

{
   "cluster_topology" : [
      {
         "allocator_filter" : {},
         "enterprise_search" : {
            "docker_image" : "string",
            "system_settings" : {
               "elasticsearch_password" : "string",
               "elasticsearch_url" : "string",
               "elasticsearch_username" : "string",
               "secret_session_key" : "string"
            },
            "user_settings_json" : {},
            "user_settings_override_json" : {},
            "user_settings_override_yaml" : "string",
            "user_settings_yaml" : "string",
            "version" : "string"
         },
         "instance_configuration_id" : "string",
         "memory_per_node" : {},
         "node_configuration" : "string",
         "node_count_per_zone" : {},
         "node_type" : {
            "appserver" : true,
            "connector" : true,
            "worker" : true
         },
         "size" : {
            "resource" : "string",
            "value" : 0
         },
         "zone_count" : 0
      }
   ],
   "enterprise_search" : null,
   "transient" : {
      "plan_configuration" : {
         "calm_wait_time" : 0,
         "cluster_reboot" : "string",
         "extended_maintenance" : true,
         "move_allocators" : [
            {
               "allocator_down" : true,
               "from" : "string",
               "to" : [
                  "string"
               ]
            }
         ],
         "move_instances" : [
            {
               "from" : "string",
               "instance_down" : true,
               "to" : [
                  "string"
               ]
            }
         ],
         "preferred_allocators" : [
            "string"
         ],
         "reallocate_instances" : true,
         "timeout" : 0
      },
      "strategy" : {
         "autodetect" : {},
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   }
}

EnterpriseSearchPlanControlConfiguration

Intentionally left blank

Properties

calm_wait_time (integer as int64)
This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
cluster_reboot (string; allowed values: [forced])
Set to 'forced' to force a reboot as part of the upgrade plan
extended_maintenance (boolean)
If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
move_allocators (array[AllocatorMoveRequest])
move_instances (array[InstanceMoveRequest])
preferred_allocators (array[string])
List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
reallocate_instances (boolean)
If true (default: false) does not allow re-using any existing instances currently in the cluster, i.e. even unchanged instances will be re-created
timeout (integer as int64)
The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

Example

{
   "calm_wait_time" : 0,
   "cluster_reboot" : "string",
   "extended_maintenance" : true,
   "move_allocators" : [
      {
         "allocator_down" : true,
         "from" : "string",
         "to" : [
            "string"
         ]
      }
   ],
   "move_instances" : [
      {
         "from" : "string",
         "instance_down" : true,
         "to" : [
            "string"
         ]
      }
   ],
   "preferred_allocators" : [
      "string"
   ],
   "reallocate_instances" : true,
   "timeout" : 0
}

EnterpriseSearchPlanInfo

Information about the Enterprise Search Server plan.

Properties

attempt_end_time (string as date-time)
If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
attempt_start_time (string as date-time)
When this plan attempt (ie to apply the plan to the Enterprise Search) started (ISO format in UTC)
healthy (boolean, required)
Either the plan ended successfully, or is not yet completed (and no errors have occurred)
plan (EnterpriseSearchPlan)
plan_attempt_id (string)
A UUID for each plan attempt
plan_attempt_log (array[ClusterPlanStepInfo], required)
plan_attempt_name (string)
A human readable name for each plan attempt, only populated when retrieving plan histories
plan_end_time (string as date-time)
If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
source (ChangeSourceInfo)
Information describing the source that facilitated the plans current state

Example

{
   "attempt_end_time" : "2019-01-01T00:00:00Z",
   "attempt_start_time" : "2019-01-01T00:00:00Z",
   "healthy" : true,
   "plan" : {
      "cluster_topology" : [
         {
            "allocator_filter" : {},
            "enterprise_search" : {
               "docker_image" : "string",
               "system_settings" : {
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string",
                  "secret_session_key" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "instance_configuration_id" : "string",
            "memory_per_node" : {},
            "node_configuration" : "string",
            "node_count_per_zone" : {},
            "node_type" : {
               "appserver" : true,
               "connector" : true,
               "worker" : true
            },
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "enterprise_search" : null,
      "transient" : {
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "move_allocators" : [
               {
                  "allocator_down" : true,
                  "from" : "string",
                  "to" : [
                     "string"
                  ]
               }
            ],
            "move_instances" : [
               {
                  "from" : "string",
                  "instance_down" : true,
                  "to" : [
                     "string"
                  ]
               }
            ],
            "preferred_allocators" : [
               "string"
            ],
            "reallocate_instances" : true,
            "timeout" : 0
         },
         "strategy" : {
            "autodetect" : {},
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   },
   "plan_attempt_id" : "string",
   "plan_attempt_log" : [
      {
         "completed" : "2019-01-01T00:00:00Z",
         "duration_in_millis" : 0,
         "info_log" : [
            {
               "delta_in_millis" : 0,
               "message" : "string",
               "stage" : "string",
               "timestamp" : "2019-01-01T00:00:00Z"
            }
         ],
         "stage" : "string",
         "started" : "2019-01-01T00:00:00Z",
         "status" : "string",
         "step_id" : "string"
      }
   ],
   "plan_attempt_name" : "string",
   "plan_end_time" : "2019-01-01T00:00:00Z",
   "source" : {
      "action" : "string",
      "admin_id" : "string",
      "date" : "2019-01-01T00:00:00Z",
      "facilitator" : "string",
      "remote_addresses" : [
         "string"
      ],
      "user_id" : "string"
   }
}

EnterpriseSearchPlansInfo

Information about current, pending, and past Enterprise Search Server plans.

Properties

current (EnterpriseSearchPlanInfo)
Information about the Enterprise Search Server plan.
healthy (boolean, required)
Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
history (array[EnterpriseSearchPlanInfo], required)
pending (EnterpriseSearchPlanInfo)
Information about the Enterprise Search Server plan.

Example

{
   "current" : {
      "attempt_end_time" : "2019-01-01T00:00:00Z",
      "attempt_start_time" : "2019-01-01T00:00:00Z",
      "healthy" : true,
      "plan" : {
         "cluster_topology" : [
            {
               "allocator_filter" : {},
               "enterprise_search" : {
                  "docker_image" : "string",
                  "system_settings" : {
                     "elasticsearch_password" : "string",
                     "elasticsearch_url" : "string",
                     "elasticsearch_username" : "string",
                     "secret_session_key" : "string"
                  },
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "instance_configuration_id" : "string",
               "memory_per_node" : {},
               "node_configuration" : "string",
               "node_count_per_zone" : {},
               "node_type" : {
                  "appserver" : true,
                  "connector" : true,
                  "worker" : true
               },
               "size" : {
                  "resource" : "string",
                  "value" : 0
               },
               "zone_count" : 0
            }
         ],
         "enterprise_search" : null,
         "transient" : {
            "plan_configuration" : {
               "calm_wait_time" : 0,
               "cluster_reboot" : "string",
               "extended_maintenance" : true,
               "move_allocators" : [
                  {
                     "allocator_down" : true,
                     "from" : "string",
                     "to" : [
                        "string"
                     ]
                  }
               ],
               "move_instances" : [
                  {
                     "from" : "string",
                     "instance_down" : true,
                     "to" : [
                        "string"
                     ]
                  }
               ],
               "preferred_allocators" : [
                  "string"
               ],
               "reallocate_instances" : true,
               "timeout" : 0
            },
            "strategy" : {
               "autodetect" : {},
               "grow_and_shrink" : {},
               "rolling" : {
                  "allow_inline_resize" : true,
                  "group_by" : "string",
                  "shard_init_wait_time" : 0,
                  "skip_synced_flush" : true
               },
               "rolling_grow_and_shrink" : {}
            }
         }
      },
      "plan_attempt_id" : "string",
      "plan_attempt_log" : [
         {
            "completed" : "2019-01-01T00:00:00Z",
            "duration_in_millis" : 0,
            "info_log" : [
               {
                  "delta_in_millis" : 0,
                  "message" : "string",
                  "stage" : "string",
                  "timestamp" : "2019-01-01T00:00:00Z"
               }
            ],
            "stage" : "string",
            "started" : "2019-01-01T00:00:00Z",
            "status" : "string",
            "step_id" : "string"
         }
      ],
      "plan_attempt_name" : "string",
      "plan_end_time" : "2019-01-01T00:00:00Z",
      "source" : {
         "action" : "string",
         "admin_id" : "string",
         "date" : "2019-01-01T00:00:00Z",
         "facilitator" : "string",
         "remote_addresses" : [
            "string"
         ],
         "user_id" : "string"
      }
   },
   "healthy" : true,
   "history" : [
      null
   ],
   "pending" : null
}

EnterpriseSearchResourceInfo

Describes an Enterprise Search resource belonging to a Deployment

Properties

elasticsearch_cluster_ref_id (string, required)
The Elasticsearch cluster that this resource depends on.
id (string, required)
The randomly-generated id of a Resource
info (EnterpriseSearchInfo, required)
Info for the resource.
ref_id (string, required)
The locally-unique user-specified id of a Resource
region (string, required)
The region where this resource exists

Example

{
   "elasticsearch_cluster_ref_id" : "string",
   "id" : "string",
   "info" : {
      "deployment_id" : "string",
      "elasticsearch_cluster" : {
         "elasticsearch_id" : "string",
         "links" : {
            "some_property" : {
               "need_elevated_permissions" : true
            }
         }
      },
      "external_links" : [
         {
            "id" : "string",
            "label" : "string",
            "uri" : "string"
         }
      ],
      "healthy" : true,
      "id" : "string",
      "links" : {
         "some_property" : null
      },
      "metadata" : {
         "cloud_id" : "string",
         "endpoint" : "string",
         "last_modified" : "2019-01-01T00:00:00Z",
         "ports" : {
            "http" : 0,
            "https" : 0
         },
         "raw" : {},
         "version" : 0
      },
      "name" : "string",
      "plan_info" : {
         "current" : {
            "attempt_end_time" : "2019-01-01T00:00:00Z",
            "attempt_start_time" : "2019-01-01T00:00:00Z",
            "healthy" : true,
            "plan" : {
               "cluster_topology" : [
                  {
                     "allocator_filter" : {},
                     "enterprise_search" : {
                        "docker_image" : "string",
                        "system_settings" : {
                           "elasticsearch_password" : "string",
                           "elasticsearch_url" : "string",
                           "elasticsearch_username" : "string",
                           "secret_session_key" : "string"
                        },
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "instance_configuration_id" : "string",
                     "memory_per_node" : {},
                     "node_configuration" : "string",
                     "node_count_per_zone" : {},
                     "node_type" : {
                        "appserver" : true,
                        "connector" : true,
                        "worker" : true
                     },
                     "size" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "zone_count" : 0
                  }
               ],
               "enterprise_search" : null,
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "move_allocators" : [
                        {
                           "allocator_down" : true,
                           "from" : "string",
                           "to" : [
                              "string"
                           ]
                        }
                     ],
                     "move_instances" : [
                        {
                           "from" : "string",
                           "instance_down" : true,
                           "to" : [
                              "string"
                           ]
                        }
                     ],
                     "preferred_allocators" : [
                        "string"
                     ],
                     "reallocate_instances" : true,
                     "timeout" : 0
                  },
                  "strategy" : {
                     "autodetect" : {},
                     "grow_and_shrink" : {},
                     "rolling" : {
                        "allow_inline_resize" : true,
                        "group_by" : "string",
                        "shard_init_wait_time" : 0,
                        "skip_synced_flush" : true
                     },
                     "rolling_grow_and_shrink" : {}
                  }
               }
            },
            "plan_attempt_id" : "string",
            "plan_attempt_log" : [
               {
                  "completed" : "2019-01-01T00:00:00Z",
                  "duration_in_millis" : 0,
                  "info_log" : [
                     {
                        "delta_in_millis" : 0,
                        "message" : "string",
                        "stage" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     }
                  ],
                  "stage" : "string",
                  "started" : "2019-01-01T00:00:00Z",
                  "status" : "string",
                  "step_id" : "string"
               }
            ],
            "plan_attempt_name" : "string",
            "plan_end_time" : "2019-01-01T00:00:00Z",
            "source" : {
               "action" : "string",
               "admin_id" : "string",
               "date" : "2019-01-01T00:00:00Z",
               "facilitator" : "string",
               "remote_addresses" : [
                  "string"
               ],
               "user_id" : "string"
            }
         },
         "healthy" : true,
         "history" : [
            null
         ],
         "pending" : null
      },
      "region" : "string",
      "settings" : {
         "metadata" : {
            "name" : "string"
         }
      },
      "status" : "string",
      "topology" : {
         "healthy" : true,
         "instances" : [
            {
               "allocator_id" : "string",
               "container_started" : true,
               "disk" : {
                  "disk_space_available" : 0,
                  "disk_space_used" : 0,
                  "storage_multiplier" : 0.1
               },
               "healthy" : true,
               "instance_configuration" : {
                  "id" : "string",
                  "name" : "string",
                  "resource" : "string"
               },
               "instance_name" : "string",
               "maintenance_mode" : true,
               "memory" : {
                  "instance_capacity" : 0,
                  "instance_capacity_planned" : 0,
                  "memory_pressure" : 0,
                  "native_memory_pressure" : 0
               },
               "service_id" : "string",
               "service_roles" : [
                  "string"
               ],
               "service_running" : true,
               "service_version" : "string",
               "zone" : "string"
            }
         ]
      }
   },
   "ref_id" : "string",
   "region" : "string"
}

EnterpriseSearchSettings

The settings for the Enterprise Search.

Properties

metadata (ClusterMetadataSettings)
The top-level configuration settings for the Elasticsearch cluster.

Example

{
   "metadata" : {
      "name" : "string"
   }
}

EnterpriseSearchSubInfo

Information about the APM Servers associated with the Elasticsearch cluster.

Properties

enabled (boolean, required)
Whether the associated Enterprise Search is currently available
enterprise_search_id (string, required)
The Enterprise Search Id
links (map[string,Hyperlink])
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

Example

{
   "enabled" : true,
   "enterprise_search_id" : "string",
   "links" : {
      "some_property" : {
         "need_elevated_permissions" : true
      }
   }
}

EnterpriseSearchSystemSettings

This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override_' and 'user_settings_' defines the total set of Enterprise Search settings)

Properties

elasticsearch_password (string)
Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified)
elasticsearch_url (string)
Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
elasticsearch_username (string)
Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified)
secret_session_key (string)
Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession

Example

{
   "elasticsearch_password" : "string",
   "elasticsearch_url" : "string",
   "elasticsearch_username" : "string",
   "secret_session_key" : "string"
}

EnterpriseSearchTopologyElement

Defines the topology of the Enterprise Search nodes (e.g. number/capacity of nodes, and where they can be allocated)

Properties

allocator_filter (object)
enterprise_search (EnterpriseSearchConfiguration)
instance_configuration_id (string)
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
memory_per_node (object)
node_configuration (string)
node_count_per_zone (object)
node_type (EnterpriseSearchNodeTypes)
Defines the EnterpriseSearch node type
size (TopologySize)
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
zone_count (integer as int32)
number of zones in which nodes will be placed

Example

{
   "allocator_filter" : {},
   "enterprise_search" : {
      "docker_image" : "string",
      "system_settings" : {
         "elasticsearch_password" : "string",
         "elasticsearch_url" : "string",
         "elasticsearch_username" : "string",
         "secret_session_key" : "string"
      },
      "user_settings_json" : {},
      "user_settings_override_json" : {},
      "user_settings_override_yaml" : "string",
      "user_settings_yaml" : "string",
      "version" : "string"
   },
   "instance_configuration_id" : "string",
   "memory_per_node" : {},
   "node_configuration" : "string",
   "node_count_per_zone" : {},
   "node_type" : {
      "appserver" : true,
      "connector" : true,
      "worker" : true
   },
   "size" : {
      "resource" : "string",
      "value" : 0
   },
   "zone_count" : 0
}

ExistsQuery

Matches documents that have at least one non-null value in the original field.

Properties

field (string, required)
The field to check for non-null values in.

Example

{
   "field" : "string"
}

ExternalHyperlink

Intentionally left blank

Properties

id (string, required)
Identifier of the external link
label (string, required)
Human-readable description of the external link
uri (string)
hyperlink to an external resource

Example

{
   "id" : "string",
   "label" : "string",
   "uri" : "string"
}

GrowShrinkStrategyConfig

A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.

Example

{}

Hyperlink

Intentionally left blank

Properties

need_elevated_permissions (boolean)
Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).

Example

{
   "need_elevated_permissions" : true
}

IndexPattern

An index pattern described indicating how it has to be migrated to ILM.

Properties

index_pattern (string, required)
Index pattern to which the ILM policy will be applied.
node_attributes (map[string,string])
Defines the Elasticsearch node attributes for the warm element of the topology
policy_name (string, required)
Name of the policy to create

Example

{
   "index_pattern" : "string",
   "node_attributes" : {
      "some_property" : "string"
   },
   "policy_name" : "string"
}

InstanceMoveRequest

The request that specifies the Elasticsearch instances, Kibana instances, and APM Servers to move to allocators as part of the upgrade plan.

Properties

from (string, required)
The instance id that is going to be moved
instance_down (boolean)
Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
to (array[string])
An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)

Example

{
   "from" : "string",
   "instance_down" : true,
   "to" : [
      "string"
   ]
}

IpFilteringSettings

The configuration settings for IP filtering.

Properties

rulesets (array[string], required)
IDs of the IP filter rulesets

Example

{
   "rulesets" : [
      "string"
   ]
}

Kibana

Holds diagnostics for a Kibana resource

Properties

backend_plan (object, required)
The backend plan as JSON
display_name (string, required)
The human readable name (defaults to the generated cluster id if not specified)
elasticsearch_cluster_ref_id (string, required)
The user-specified id of the Elasticsearch Cluster that this will link to
ref_id (string, required)
A locally-unique user-specified id

Example

{
   "backend_plan" : {},
   "display_name" : "string",
   "elasticsearch_cluster_ref_id" : "string",
   "ref_id" : "string"
}

KibanaClusterInfo

The top-level object information for a Kibana instance.

Properties

cluster_id (string, required)
The id of the cluster
cluster_name (string, required)
The name of the cluster
deployment_id (string)
The id of the deployment to which this Kibana Server belongs to.
elasticsearch_cluster (TargetElasticsearchCluster, required)
Information about the specified Elasticsearch cluster.
external_links (array[ExternalHyperlink], required)
External resources related to the cluster
healthy (boolean, required)
Whether the cluster is healthy or not (one or more of the info subsections will have healthy: false)
links (map[string,Hyperlink])
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
metadata (ClusterMetadataInfo, required)
Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.
plan_info (KibanaClusterPlansInfo, required)
Information about the current, pending, or past Kibana instance plans.
region (string)
The region that this cluster belongs to. Only populated in SaaS or federated ECE.
settings (KibanaClusterSettings)
The cluster metadata settings for a kibana cluster
status (string; allowed values: [initializing, stopping, stopped, rebooting, restarting, reconfiguring, started], required)
Cluster status
topology (ClusterTopologyInfo, required)
The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The ClusterTopologyInfo also includes the instances and containers, and where they are located.

Example

{
   "cluster_id" : "string",
   "cluster_name" : "string",
   "deployment_id" : "string",
   "elasticsearch_cluster" : {
      "elasticsearch_id" : "string",
      "links" : {
         "some_property" : {
            "need_elevated_permissions" : true
         }
      }
   },
   "external_links" : [
      {
         "id" : "string",
         "label" : "string",
         "uri" : "string"
      }
   ],
   "healthy" : true,
   "links" : {
      "some_property" : null
   },
   "metadata" : {
      "cloud_id" : "string",
      "endpoint" : "string",
      "last_modified" : "2019-01-01T00:00:00Z",
      "ports" : {
         "http" : 0,
         "https" : 0
      },
      "raw" : {},
      "version" : 0
   },
   "plan_info" : {
      "current" : {
         "attempt_end_time" : "2019-01-01T00:00:00Z",
         "attempt_start_time" : "2019-01-01T00:00:00Z",
         "healthy" : true,
         "plan" : {
            "cluster_topology" : [
               {
                  "instance_configuration_id" : "string",
                  "kibana" : {
                     "docker_image" : "string",
                     "system_settings" : {
                        "elasticsearch_password" : "string",
                        "elasticsearch_url" : "string",
                        "elasticsearch_username" : "string"
                     },
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "kibana" : null,
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "timeout" : 0
               },
               "strategy" : {
                  "autodetect" : {},
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         },
         "plan_attempt_id" : "string",
         "plan_attempt_log" : [
            {
               "completed" : "2019-01-01T00:00:00Z",
               "duration_in_millis" : 0,
               "info_log" : [
                  {
                     "delta_in_millis" : 0,
                     "message" : "string",
                     "stage" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z"
                  }
               ],
               "stage" : "string",
               "started" : "2019-01-01T00:00:00Z",
               "status" : "string",
               "step_id" : "string"
            }
         ],
         "plan_attempt_name" : "string",
         "plan_end_time" : "2019-01-01T00:00:00Z",
         "source" : {
            "action" : "string",
            "admin_id" : "string",
            "date" : "2019-01-01T00:00:00Z",
            "facilitator" : "string",
            "remote_addresses" : [
               "string"
            ],
            "user_id" : "string"
         }
      },
      "healthy" : true,
      "history" : [
         null
      ],
      "pending" : null
   },
   "region" : "string",
   "settings" : {
      "metadata" : {
         "name" : "string"
      }
   },
   "status" : "string",
   "topology" : {
      "healthy" : true,
      "instances" : [
         {
            "allocator_id" : "string",
            "container_started" : true,
            "disk" : {
               "disk_space_available" : 0,
               "disk_space_used" : 0,
               "storage_multiplier" : 0.1
            },
            "healthy" : true,
            "instance_configuration" : {
               "id" : "string",
               "name" : "string",
               "resource" : "string"
            },
            "instance_name" : "string",
            "maintenance_mode" : true,
            "memory" : {
               "instance_capacity" : 0,
               "instance_capacity_planned" : 0,
               "memory_pressure" : 0,
               "native_memory_pressure" : 0
            },
            "service_id" : "string",
            "service_roles" : [
               "string"
            ],
            "service_running" : true,
            "service_version" : "string",
            "zone" : "string"
         }
      ]
   }
}

KibanaClusterPlan

The plan for the Kibana instance.

Properties

cluster_topology (array[KibanaClusterTopologyElement])
kibana (KibanaConfiguration, required)
The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
transient (TransientKibanaPlanConfiguration)
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

Example

{
   "cluster_topology" : [
      {
         "instance_configuration_id" : "string",
         "kibana" : {
            "docker_image" : "string",
            "system_settings" : {
               "elasticsearch_password" : "string",
               "elasticsearch_url" : "string",
               "elasticsearch_username" : "string"
            },
            "user_settings_json" : {},
            "user_settings_override_json" : {},
            "user_settings_override_yaml" : "string",
            "user_settings_yaml" : "string",
            "version" : "string"
         },
         "size" : {
            "resource" : "string",
            "value" : 0
         },
         "zone_count" : 0
      }
   ],
   "kibana" : null,
   "transient" : {
      "plan_configuration" : {
         "calm_wait_time" : 0,
         "cluster_reboot" : "string",
         "extended_maintenance" : true,
         "timeout" : 0
      },
      "strategy" : {
         "autodetect" : {},
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   }
}

KibanaClusterPlanInfo

Information about the current, pending, or past Kibana instance plan.

Properties

attempt_end_time (string as date-time)
If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
attempt_start_time (string as date-time)
When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)
healthy (boolean, required)
Either the plan ended successfully, or is not yet completed (and no errors have occurred)
plan (KibanaClusterPlan)
The plan for the Kibana instance.
plan_attempt_id (string)
A UUID for each plan attempt
plan_attempt_log (array[ClusterPlanStepInfo], required)
plan_attempt_name (string)
A human readable name for each plan attempt, only populated when retrieving plan histories
plan_end_time (string as date-time)
If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
source (ChangeSourceInfo)
Information describing the source that facilitated the plans current state

Example

{
   "attempt_end_time" : "2019-01-01T00:00:00Z",
   "attempt_start_time" : "2019-01-01T00:00:00Z",
   "healthy" : true,
   "plan" : {
      "cluster_topology" : [
         {
            "instance_configuration_id" : "string",
            "kibana" : {
               "docker_image" : "string",
               "system_settings" : {
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "kibana" : null,
      "transient" : {
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "timeout" : 0
         },
         "strategy" : {
            "autodetect" : {},
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   },
   "plan_attempt_id" : "string",
   "plan_attempt_log" : [
      {
         "completed" : "2019-01-01T00:00:00Z",
         "duration_in_millis" : 0,
         "info_log" : [
            {
               "delta_in_millis" : 0,
               "message" : "string",
               "stage" : "string",
               "timestamp" : "2019-01-01T00:00:00Z"
            }
         ],
         "stage" : "string",
         "started" : "2019-01-01T00:00:00Z",
         "status" : "string",
         "step_id" : "string"
      }
   ],
   "plan_attempt_name" : "string",
   "plan_end_time" : "2019-01-01T00:00:00Z",
   "source" : {
      "action" : "string",
      "admin_id" : "string",
      "date" : "2019-01-01T00:00:00Z",
      "facilitator" : "string",
      "remote_addresses" : [
         "string"
      ],
      "user_id" : "string"
   }
}

KibanaClusterPlansInfo

Information about the current, pending, or past Kibana instance plans.

Properties

current (KibanaClusterPlanInfo)
Information about the current, pending, or past Kibana instance plan.
healthy (boolean, required)
Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
history (array[KibanaClusterPlanInfo], required)
pending (KibanaClusterPlanInfo)
Information about the current, pending, or past Kibana instance plan.

Example

{
   "current" : {
      "attempt_end_time" : "2019-01-01T00:00:00Z",
      "attempt_start_time" : "2019-01-01T00:00:00Z",
      "healthy" : true,
      "plan" : {
         "cluster_topology" : [
            {
               "instance_configuration_id" : "string",
               "kibana" : {
                  "docker_image" : "string",
                  "system_settings" : {
                     "elasticsearch_password" : "string",
                     "elasticsearch_url" : "string",
                     "elasticsearch_username" : "string"
                  },
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "size" : {
                  "resource" : "string",
                  "value" : 0
               },
               "zone_count" : 0
            }
         ],
         "kibana" : null,
         "transient" : {
            "plan_configuration" : {
               "calm_wait_time" : 0,
               "cluster_reboot" : "string",
               "extended_maintenance" : true,
               "timeout" : 0
            },
            "strategy" : {
               "autodetect" : {},
               "grow_and_shrink" : {},
               "rolling" : {
                  "allow_inline_resize" : true,
                  "group_by" : "string",
                  "shard_init_wait_time" : 0,
                  "skip_synced_flush" : true
               },
               "rolling_grow_and_shrink" : {}
            }
         }
      },
      "plan_attempt_id" : "string",
      "plan_attempt_log" : [
         {
            "completed" : "2019-01-01T00:00:00Z",
            "duration_in_millis" : 0,
            "info_log" : [
               {
                  "delta_in_millis" : 0,
                  "message" : "string",
                  "stage" : "string",
                  "timestamp" : "2019-01-01T00:00:00Z"
               }
            ],
            "stage" : "string",
            "started" : "2019-01-01T00:00:00Z",
            "status" : "string",
            "step_id" : "string"
         }
      ],
      "plan_attempt_name" : "string",
      "plan_end_time" : "2019-01-01T00:00:00Z",
      "source" : {
         "action" : "string",
         "admin_id" : "string",
         "date" : "2019-01-01T00:00:00Z",
         "facilitator" : "string",
         "remote_addresses" : [
            "string"
         ],
         "user_id" : "string"
      }
   },
   "healthy" : true,
   "history" : [
      null
   ],
   "pending" : null
}

KibanaClusterSettings

The settings for multiple Kibana instances.

Properties

metadata (ClusterMetadataSettings)
The top-level configuration settings for the Elasticsearch cluster.

Example

{
   "metadata" : {
      "name" : "string"
   }
}

KibanaClusterTopologyElement

The topology of the Kibana nodes, including the number, capacity, and type of nodes, and where they can be allocated.

Properties

instance_configuration_id (string)
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
kibana (KibanaConfiguration)
The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
size (TopologySize)
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
zone_count (integer as int32)
number of zones in which nodes will be placed

Example

{
   "instance_configuration_id" : "string",
   "kibana" : {
      "docker_image" : "string",
      "system_settings" : {
         "elasticsearch_password" : "string",
         "elasticsearch_url" : "string",
         "elasticsearch_username" : "string"
      },
      "user_settings_json" : {},
      "user_settings_override_json" : {},
      "user_settings_override_yaml" : "string",
      "user_settings_yaml" : "string",
      "version" : "string"
   },
   "size" : {
      "resource" : "string",
      "value" : 0
   },
   "zone_count" : 0
}

KibanaConfiguration

The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.

Properties

docker_image (string)
A docker URI that allows overriding of the default docker image specified for this version
system_settings (KibanaSystemSettings)
A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.
user_settings_json (object)
An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
user_settings_override_json (object)
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
user_settings_override_yaml (string)
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings)
user_settings_yaml (string)
An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided they are on the whitelist ('user_settings_whitelist') and not on the blacklist ('user_settings_blacklist'). (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings)
version (string)
The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

Example

{
   "docker_image" : "string",
   "system_settings" : {
      "elasticsearch_password" : "string",
      "elasticsearch_url" : "string",
      "elasticsearch_username" : "string"
   },
   "user_settings_json" : {},
   "user_settings_override_json" : {},
   "user_settings_override_yaml" : "string",
   "user_settings_yaml" : "string",
   "version" : "string"
}

KibanaPayload

A Kibana creation request paired with the alias of the Elasticsearch cluster it should be paired with

Properties

display_name (string)
The human readable name for the Kibana cluster (default: takes the name of its Elasticsearch cluster)
elasticsearch_cluster_ref_id (string, required)
Alias to the Elasticsearch Cluster to attach Kibana to
plan (KibanaClusterPlan, required)
The plan for the Kibana instance.
ref_id (string, required)
A locally-unique user-specified id for Kibana
region (string, required)
The region where this resource exists
settings (KibanaClusterSettings)
The settings for building this Kibana cluster

Example

{
   "display_name" : "string",
   "elasticsearch_cluster_ref_id" : "string",
   "plan" : {
      "cluster_topology" : [
         {
            "instance_configuration_id" : "string",
            "kibana" : {
               "docker_image" : "string",
               "system_settings" : {
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "kibana" : null,
      "transient" : {
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "timeout" : 0
         },
         "strategy" : {
            "autodetect" : {},
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   },
   "ref_id" : "string",
   "region" : "string",
   "settings" : {
      "metadata" : {
         "name" : "string"
      }
   }
}

KibanaPlanControlConfiguration

The configuration settings for the timeout and fallback parameters.

Properties

calm_wait_time (integer as int64)
This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
cluster_reboot (string; allowed values: [forced])
Set to 'forced' to force a reboot as part of the upgrade plan
extended_maintenance (boolean)
If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
timeout (integer as int64)
The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)

Example

{
   "calm_wait_time" : 0,
   "cluster_reboot" : "string",
   "extended_maintenance" : true,
   "timeout" : 0
}

KibanaResourceInfo

Describes an Kibana resource belonging to a Deployment

Properties

elasticsearch_cluster_ref_id (string, required)
The Elasticsearch cluster that this resource depends on.
id (string, required)
The randomly-generated id of a Resource
info (KibanaClusterInfo, required)
Info for the resource.
ref_id (string, required)
The locally-unique user-specified id of a Resource
region (string, required)
The region where this resource exists

Example

{
   "elasticsearch_cluster_ref_id" : "string",
   "id" : "string",
   "info" : {
      "cluster_id" : "string",
      "cluster_name" : "string",
      "deployment_id" : "string",
      "elasticsearch_cluster" : {
         "elasticsearch_id" : "string",
         "links" : {
            "some_property" : {
               "need_elevated_permissions" : true
            }
         }
      },
      "external_links" : [
         {
            "id" : "string",
            "label" : "string",
            "uri" : "string"
         }
      ],
      "healthy" : true,
      "links" : {
         "some_property" : null
      },
      "metadata" : {
         "cloud_id" : "string",
         "endpoint" : "string",
         "last_modified" : "2019-01-01T00:00:00Z",
         "ports" : {
            "http" : 0,
            "https" : 0
         },
         "raw" : {},
         "version" : 0
      },
      "plan_info" : {
         "current" : {
            "attempt_end_time" : "2019-01-01T00:00:00Z",
            "attempt_start_time" : "2019-01-01T00:00:00Z",
            "healthy" : true,
            "plan" : {
               "cluster_topology" : [
                  {
                     "instance_configuration_id" : "string",
                     "kibana" : {
                        "docker_image" : "string",
                        "system_settings" : {
                           "elasticsearch_password" : "string",
                           "elasticsearch_url" : "string",
                           "elasticsearch_username" : "string"
                        },
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "size" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "zone_count" : 0
                  }
               ],
               "kibana" : null,
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "timeout" : 0
                  },
                  "strategy" : {
                     "autodetect" : {},
                     "grow_and_shrink" : {},
                     "rolling" : {
                        "allow_inline_resize" : true,
                        "group_by" : "string",
                        "shard_init_wait_time" : 0,
                        "skip_synced_flush" : true
                     },
                     "rolling_grow_and_shrink" : {}
                  }
               }
            },
            "plan_attempt_id" : "string",
            "plan_attempt_log" : [
               {
                  "completed" : "2019-01-01T00:00:00Z",
                  "duration_in_millis" : 0,
                  "info_log" : [
                     {
                        "delta_in_millis" : 0,
                        "message" : "string",
                        "stage" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     }
                  ],
                  "stage" : "string",
                  "started" : "2019-01-01T00:00:00Z",
                  "status" : "string",
                  "step_id" : "string"
               }
            ],
            "plan_attempt_name" : "string",
            "plan_end_time" : "2019-01-01T00:00:00Z",
            "source" : {
               "action" : "string",
               "admin_id" : "string",
               "date" : "2019-01-01T00:00:00Z",
               "facilitator" : "string",
               "remote_addresses" : [
                  "string"
               ],
               "user_id" : "string"
            }
         },
         "healthy" : true,
         "history" : [
            null
         ],
         "pending" : null
      },
      "region" : "string",
      "settings" : {
         "metadata" : {
            "name" : "string"
         }
      },
      "status" : "string",
      "topology" : {
         "healthy" : true,
         "instances" : [
            {
               "allocator_id" : "string",
               "container_started" : true,
               "disk" : {
                  "disk_space_available" : 0,
                  "disk_space_used" : 0,
                  "storage_multiplier" : 0.1
               },
               "healthy" : true,
               "instance_configuration" : {
                  "id" : "string",
                  "name" : "string",
                  "resource" : "string"
               },
               "instance_name" : "string",
               "maintenance_mode" : true,
               "memory" : {
                  "instance_capacity" : 0,
                  "instance_capacity_planned" : 0,
                  "memory_pressure" : 0,
                  "native_memory_pressure" : 0
               },
               "service_id" : "string",
               "service_roles" : [
                  "string"
               ],
               "service_running" : true,
               "service_version" : "string",
               "zone" : "string"
            }
         ]
      }
   },
   "ref_id" : "string",
   "region" : "string"
}

KibanaSubClusterInfo

Information about the Kibana instances associated with the Elasticsearch cluster.

Properties

enabled (boolean, required)
Whether the associated Kibana cluster is currently available
kibana_id (string, required)
The Kibana cluster Id
links (map[string,Hyperlink])
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

Example

{
   "enabled" : true,
   "kibana_id" : "string",
   "links" : {
      "some_property" : {
         "need_elevated_permissions" : true
      }
   }
}

KibanaSystemSettings

A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use KibanaSystemSettings with user_settings_override_ and user_settings_.

Properties

elasticsearch_password (string)
Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified)
elasticsearch_url (string)
Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
elasticsearch_username (string)
Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified)

Example

{
   "elasticsearch_password" : "string",
   "elasticsearch_url" : "string",
   "elasticsearch_username" : "string"
}

ManagedMonitoringSettings

The settings for sending monitoring information to another cluster.

Properties

target_cluster_id (string, required)
The Id of the target cluster to which to send monitoring information

Example

{
   "target_cluster_id" : "string"
}

MatchAllQuery

A query that matches all documents.

Example

{}

MatchNoneQuery

A query that doesn't match any documents.

Example

{}

MatchQuery

Consumes and analyzes text, numbers, and dates, then constructs a query.

Properties

analyzer (string)
The analyzer that will be used to perform the analysis process on the text. Defaults to the analyzer that was used to index the field.
minimum_should_match (integer as int32)
The minimum number of optional should clauses to match.
operator (string)
The operator flag can be set to or or and to control the boolean clauses (defaults to or).
query (string, required)
The text/numeric/date to query for.

Example

{
   "analyzer" : "string",
   "minimum_should_match" : 0,
   "operator" : "string",
   "query" : "string"
}

NestedQuery

A query that matches nested objects.

Properties

path (string, required)
The path to the nested object.
query (QueryContainer, required)
The actual query to execute on the nested objects.
score_mode (string; allowed values: [avg, sum, min, max, none])
Allows to specify how inner children matching affects score of the parent. Refer to the Elasticsearch documentation for details.

Example

{
   "path" : "string",
   "query" : {
      "bool" : {
         "filter" : [
            null
         ],
         "minimum_should_match" : 0,
         "must" : [
            null
         ],
         "must_not" : [
            null
         ],
         "should" : [
            null
         ]
      },
      "exists" : {
         "field" : "string"
      },
      "match" : {
         "some_property" : {
            "analyzer" : "string",
            "minimum_should_match" : 0,
            "operator" : "string",
            "query" : "string"
         }
      },
      "match_all" : {},
      "match_none" : {},
      "nested" : null,
      "prefix" : {
         "some_property" : {
            "boost" : 0.1,
            "value" : "string"
         }
      },
      "query_string" : {
         "allow_leading_wildcard" : true,
         "analyzer" : "string",
         "default_field" : "string",
         "default_operator" : "string",
         "query" : "string"
      },
      "range" : {
         "some_property" : {
            "boost" : 0.1,
            "format" : "string",
            "gt" : {},
            "gte" : {},
            "lt" : {},
            "lte" : {},
            "time_zone" : "string"
         }
      },
      "term" : {
         "some_property" : {
            "value" : {}
         }
      }
   },
   "score_mode" : "string"
}

Orphaned

Details about orphaned resources.

Properties

apm (array[string], required)
List of orphaned APM resource ids
appsearch (array[string], required)
List of orphaned AppSearch resource ids
elasticsearch (array[OrphanedElasticsearch], required)
List of orphaned Elasticsearch resources
enterprise_search (array[string], required)
List of orphaned Enterprise Search resource ids
kibana (array[string], required)
List of orphaned Kibana resource ids

Example

{
   "apm" : [
      "string"
   ],
   "appsearch" : [
      "string"
   ],
   "elasticsearch" : [
      {
         "dependents" : [
            {
               "id" : "string",
               "kind" : "string"
            }
         ],
         "id" : "string"
      }
   ],
   "enterprise_search" : [
      "string"
   ],
   "kibana" : [
      "string"
   ]
}

OrphanedElasticsearch

Details about an orphaned Elasticsearch resources.

Properties

dependents (array[ElasticsearchDependant], required)
List of orphaned dependent resources
id (string, required)
The id of the orphaned resource

Example

{
   "dependents" : [
      {
         "id" : "string",
         "kind" : "string"
      }
   ],
   "id" : "string"
}

PlanStrategy

The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

Properties

autodetect (AutodetectStrategyConfig)
A strategy that lets constructor choose the most optimal way to execute the plan.
grow_and_shrink (GrowShrinkStrategyConfig)
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. GrowShrinkStrategyConfig is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.
rolling (RollingStrategyConfig)
Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to '*all*';, rolling is required.
rolling_grow_and_shrink (RollingGrowShrinkStrategyConfig)
A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

Example

{
   "autodetect" : {},
   "grow_and_shrink" : {},
   "rolling" : {
      "allow_inline_resize" : true,
      "group_by" : "string",
      "shard_init_wait_time" : 0,
      "skip_synced_flush" : true
   },
   "rolling_grow_and_shrink" : {}
}

PrefixQuery

The query that matches documents with fields that contain terms with a specified, not analyzed, prefix.

Properties

boost (number as float)
An optional boost value to apply to the query.
value (string, required)
The prefix to search for.

Example

{
   "boost" : 0.1,
   "value" : "string"
}

QueryContainer

The container for all of the allowed Elasticsearch queries. Specify only one property each time.

Properties

bool (BoolQuery)
A query for documents that match boolean combinations of other queries.
exists (ExistsQuery)
Matches documents that have at least one non-null value in the original field.
match (map[string,MatchQuery])
match_all (MatchAllQuery)
A query that matches all documents.
match_none (MatchNoneQuery)
A query that doesn't match any documents.
nested (NestedQuery)
A query that matches nested objects.
prefix (map[string,PrefixQuery])
query_string (QueryStringQuery)
A query that uses the SimpleQueryParser for parsing.
range (map[string,RangeQuery])
term (map[string,TermQuery])

Example

{
   "bool" : {
      "filter" : [
         null
      ],
      "minimum_should_match" : 0,
      "must" : [
         null
      ],
      "must_not" : [
         null
      ],
      "should" : [
         null
      ]
   },
   "exists" : {
      "field" : "string"
   },
   "match" : {
      "some_property" : {
         "analyzer" : "string",
         "minimum_should_match" : 0,
         "operator" : "string",
         "query" : "string"
      }
   },
   "match_all" : {},
   "match_none" : {},
   "nested" : {
      "path" : "string",
      "query" : null,
      "score_mode" : "string"
   },
   "prefix" : {
      "some_property" : {
         "boost" : 0.1,
         "value" : "string"
      }
   },
   "query_string" : {
      "allow_leading_wildcard" : true,
      "analyzer" : "string",
      "default_field" : "string",
      "default_operator" : "string",
      "query" : "string"
   },
   "range" : {
      "some_property" : {
         "boost" : 0.1,
         "format" : "string",
         "gt" : {},
         "gte" : {},
         "lt" : {},
         "lte" : {},
         "time_zone" : "string"
      }
   },
   "term" : {
      "some_property" : {
         "value" : {}
      }
   }
}

QueryStringQuery

A query that uses the SimpleQueryParser for parsing.

Properties

allow_leading_wildcard (boolean)
When set, * or ? are allowed as the first character. Defaults to false.
analyzer (string)
The analyzer used to analyze each term of the query when creating composite queries.
default_field (string)
The default field for query terms if no prefix field is specified.
default_operator (string)
The default operator used if no explicit operator is specified.
query (string, required)
The actual query to be parsed.

Example

{
   "allow_leading_wildcard" : true,
   "analyzer" : "string",
   "default_field" : "string",
   "default_operator" : "string",
   "query" : "string"
}

RangeQuery

The query that matches documents with fields that contain terms within a specified range.

Properties

boost (number as float)
An optional boost value to apply to the query.
format (string)
Formatted dates will be parsed using the format specified on the date field by default, but it can be overridden by passing the format parameter.
gt (object)
Greater-than
gte (object)
Greater-than or equal to
lt (object)
Less-than
lte (object)
Less-than or equal to.
time_zone (string)
Dates can be converted from another timezone to UTC either by specifying the time zone in the date value itself (if the format accepts it), or it can be specified as the time_zone parameter.

Example

{
   "boost" : 0.1,
   "format" : "string",
   "gt" : {},
   "gte" : {},
   "lt" : {},
   "lte" : {},
   "time_zone" : "string"
}

RemoteClusterInfo

Information about the remote cluster for cross-cluster search.

Properties

compatible (boolean, required)
Flag indicating whether the remote cluster version is compatible
id (string, required)
The remote Elasticsearch cluster deployment id
version (string)
Remote cluster Elasticsearch version

Example

{
   "compatible" : true,
   "id" : "string",
   "version" : "string"
}

RemoteClusterRef

The Elasticsearch cluster to connect to for cross-cluster search.

Properties

cluster_id (string, required)
Cluster id of the remote cluster
skip_unavailable (boolean)
If true, skip this cluster during search if it is disconnected. Default: false

Example

{
   "cluster_id" : "string",
   "skip_unavailable" : true
}

RestoreSnapshotApiConfiguration

The configuration for the restore command, such as which indices you want to restore.

Properties

indices (array[string])
The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)
raw_settings (object)
This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats

Example

{
   "indices" : [
      "string"
   ],
   "raw_settings" : {}
}

RestoreSnapshotConfiguration

Restores a snapshot from a local or remote repository.

Properties

repository_config (RestoreSnapshotRepoConfiguration)
Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id
repository_name (string)
If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')
restore_payload (RestoreSnapshotApiConfiguration)
The configuration for the restore command, such as which indices you want to restore.
snapshot_name (string, required)
The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository
source_cluster_id (string)
If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config
strategy (string; allowed values: [partial, full, recovery])
The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only

Example

{
   "repository_config" : {
      "raw_settings" : {}
   },
   "repository_name" : "string",
   "restore_payload" : {
      "indices" : [
         "string"
      ],
      "raw_settings" : {}
   },
   "snapshot_name" : "string",
   "source_cluster_id" : "string",
   "strategy" : "string"
}

RestoreSnapshotRepoConfiguration

Configures the location of a remote repository. The default is the system repository.

Properties

raw_settings (object)
The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats

Example

{
   "raw_settings" : {}
}

RollingGrowShrinkStrategyConfig

A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.

Example

{}

RollingStrategyConfig

Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to '*all*';, rolling is required.

Properties

allow_inline_resize (boolean)
Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
group_by (string)
Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
shard_init_wait_time (integer as int64)
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
skip_synced_flush (boolean)
Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy

Example

{
   "allow_inline_resize" : true,
   "group_by" : "string",
   "shard_init_wait_time" : 0,
   "skip_synced_flush" : true
}

SearchRequest

An Elasticsearch search request with a subset of options.

Properties

from (integer as int32)
query (QueryContainer)
The container for all of the allowed Elasticsearch queries. Specify only one property each time.
size (integer as int32)
The maximum number of search results to return.
sort (array[object])
An array of fields to sort the search results by.

Example

{
   "from" : 0,
   "query" : {
      "bool" : {
         "filter" : [
            null
         ],
         "minimum_should_match" : 0,
         "must" : [
            null
         ],
         "must_not" : [
            null
         ],
         "should" : [
            null
         ]
      },
      "exists" : {
         "field" : "string"
      },
      "match" : {
         "some_property" : {
            "analyzer" : "string",
            "minimum_should_match" : 0,
            "operator" : "string",
            "query" : "string"
         }
      },
      "match_all" : {},
      "match_none" : {},
      "nested" : {
         "path" : "string",
         "query" : null,
         "score_mode" : "string"
      },
      "prefix" : {
         "some_property" : {
            "boost" : 0.1,
            "value" : "string"
         }
      },
      "query_string" : {
         "allow_leading_wildcard" : true,
         "analyzer" : "string",
         "default_field" : "string",
         "default_operator" : "string",
         "query" : "string"
      },
      "range" : {
         "some_property" : {
            "boost" : 0.1,
            "format" : "string",
            "gt" : {},
            "gte" : {},
            "lt" : {},
            "lte" : {},
            "time_zone" : "string"
         }
      },
      "term" : {
         "some_property" : {
            "value" : {}
         }
      }
   },
   "size" : 0,
   "sort" : [
      {}
   ]
}

SnapshotStatusInfo

Information about the snapshot status for the Elasticsearch cluster. For example, the health status.

Properties

count (integer as int32, required)
Number of snapshots stored for this cluster
healthy (boolean, required)
Health status of snapshots for this cluster
latest_end_time (string as date-time)
The end time of the most recently attempted snapshot
latest_status (string)
Status of the latest snapshot attempt, if any exist.
latest_successful (boolean)
Latest snapshot status
latest_successful_end_time (string as date-time)
The end time of the most recently successful snapshot
recent_success (boolean, required)
Indicates whether the cluster has a relatively recent successful snapshot.
scheduled_time (string as date-time)
Scheduled time of next snapshot attempt

Example

{
   "count" : 0,
   "healthy" : true,
   "latest_end_time" : "2019-01-01T00:00:00Z",
   "latest_status" : "string",
   "latest_successful" : true,
   "latest_successful_end_time" : "2019-01-01T00:00:00Z",
   "recent_success" : true,
   "scheduled_time" : "2019-01-01T00:00:00Z"
}

StackVersionApmConfig

The APM Server configuration for an Elastic Stack version.

Properties

blacklist (array[string], required)
List of configuration options that cannot be overridden by user settings
capacity_constraints (StackVersionInstanceCapacityConstraint)
The Elasticsearch instance, Kibana instance, APM Server capacity constraints for an Elastic Stack node type.
compatible_node_types (array[string])
Node types that are compatible with this one
docker_image (string, required)
Docker image for the APM
settings (object)
Settings that are applied to all nodes of this type
version (string)
Version of APM

Example

{
   "blacklist" : [
      "string"
   ],
   "capacity_constraints" : {
      "max" : 0,
      "min" : 0
   },
   "compatible_node_types" : [
      "string"
   ],
   "docker_image" : "string",
   "settings" : {},
   "version" : "string"
}

StackVersionAppSearchConfig

AppSearch related configuration of an Elastic Stack version

Properties

blacklist (array[string], required)
List of configuration options that cannot be overridden by user settings
capacity_constraints (StackVersionInstanceCapacityConstraint)
The Elasticsearch instance, Kibana instance, APM Server capacity constraints for an Elastic Stack node type.
compatible_node_types (array[string])
Node types that are compatible with this one
docker_image (string, required)
Docker image for the AppSearch
node_types (array[StackVersionNodeType])
Node types that are supported by this stack version
settings (object)
Settings that are applied to all nodes of this type
version (string)
Version of AppSearch

Example

{
   "blacklist" : [
      "string"
   ],
   "capacity_constraints" : {
      "max" : 0,
      "min" : 0
   },
   "compatible_node_types" : [
      "string"
   ],
   "docker_image" : "string",
   "node_types" : [
      {
         "capacity_constraints" : null,
         "compatible_node_types" : [
            "string"
         ],
         "description" : "string",
         "mandatory" : true,
         "name" : "string",
         "node_type" : "string",
         "settings" : {}
      }
   ],
   "settings" : {},
   "version" : "string"
}

StackVersionConfig

The details for an Elastic Stack configuration.

Properties

accessible (boolean)
Whether or not this version is accessible by the calling user. This is only relevant in EC (SaaS) and is not sent in ECE.
apm (StackVersionApmConfig)
The APM Server configuration for an Elastic Stack version.
appsearch (StackVersionAppSearchConfig)
AppSearch related configuration of an Elastic Stack version
deleted (boolean)
Identifies that the Elastic Stack version is marked for deletion
elasticsearch (StackVersionElasticsearchConfig, required)
The Elasticsearch configuration for an Elastic Stack version.
kibana (StackVersionKibanaConfig, required)
The Kibana configuration for an Elastic Stack version.
metadata (StackVersionMetadata)
The metadata for the Elastic Stack.
min_upgradable_from (string)

The minimum version recommended to upgrade this version.

Example: "6.7.0"

template (StackVersionTemplateInfo, required)
The template information for an Elastic Stack version.
upgradable_to (array[string], required)
Stack Versions that this version can upgrade to
version (string)
Stack version
whitelisted (boolean)
Whether or not this version is whitelisted. This is only relevant in EC (SaaS) and is not sent in ECE.

Example

{
   "accessible" : true,
   "apm" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : {
         "max" : 0,
         "min" : 0
      },
      "compatible_node_types" : [
         "string"
      ],
      "docker_image" : "string",
      "settings" : {},
      "version" : "string"
   },
   "appsearch" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : null,
      "compatible_node_types" : [
         "string"
      ],
      "docker_image" : "string",
      "node_types" : [
         {
            "capacity_constraints" : null,
            "compatible_node_types" : [
               "string"
            ],
            "description" : "string",
            "mandatory" : true,
            "name" : "string",
            "node_type" : "string",
            "settings" : {}
         }
      ],
      "settings" : {},
      "version" : "string"
   },
   "deleted" : true,
   "elasticsearch" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : null,
      "compatible_node_types" : [
         "string"
      ],
      "default_plugins" : [
         "string"
      ],
      "docker_image" : "string",
      "node_types" : [
         null
      ],
      "plugins" : [
         "string"
      ],
      "settings" : {}
   },
   "kibana" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : null,
      "compatible_node_types" : [
         "string"
      ],
      "docker_image" : "string",
      "settings" : {},
      "version" : "string"
   },
   "metadata" : {
      "min_platform_version" : "string",
      "notes" : "string",
      "pre_release" : true,
      "schema_version" : 0
   },
   "min_upgradable_from" : "string",
   "template" : {
      "hashes" : [
         {
            "hash" : "string",
            "path" : "string"
         }
      ],
      "template_version" : "string"
   },
   "upgradable_to" : [
      "string"
   ],
   "version" : "string",
   "whitelisted" : true
}

StackVersionConfigs

The details for multiple Elastic Stack configurations.

Properties

stacks (array[StackVersionConfig], required)

Example

{
   "stacks" : [
      {
         "accessible" : true,
         "apm" : {
            "blacklist" : [
               "string"
            ],
            "capacity_constraints" : {
               "max" : 0,
               "min" : 0
            },
            "compatible_node_types" : [
               "string"
            ],
            "docker_image" : "string",
            "settings" : {},
            "version" : "string"
         },
         "appsearch" : {
            "blacklist" : [
               "string"
            ],
            "capacity_constraints" : null,
            "compatible_node_types" : [
               "string"
            ],
            "docker_image" : "string",
            "node_types" : [
               {
                  "capacity_constraints" : null,
                  "compatible_node_types" : [
                     "string"
                  ],
                  "description" : "string",
                  "mandatory" : true,
                  "name" : "string",
                  "node_type" : "string",
                  "settings" : {}
               }
            ],
            "settings" : {},
            "version" : "string"
         },
         "deleted" : true,
         "elasticsearch" : {
            "blacklist" : [
               "string"
            ],
            "capacity_constraints" : null,
            "compatible_node_types" : [
               "string"
            ],
            "default_plugins" : [
               "string"
            ],
            "docker_image" : "string",
            "node_types" : [
               null
            ],
            "plugins" : [
               "string"
            ],
            "settings" : {}
         },
         "kibana" : {
            "blacklist" : [
               "string"
            ],
            "capacity_constraints" : null,
            "compatible_node_types" : [
               "string"
            ],
            "docker_image" : "string",
            "settings" : {},
            "version" : "string"
         },
         "metadata" : {
            "min_platform_version" : "string",
            "notes" : "string",
            "pre_release" : true,
            "schema_version" : 0
         },
         "min_upgradable_from" : "string",
         "template" : {
            "hashes" : [
               {
                  "hash" : "string",
                  "path" : "string"
               }
            ],
            "template_version" : "string"
         },
         "upgradable_to" : [
            "string"
         ],
         "version" : "string",
         "whitelisted" : true
      }
   ]
}

StackVersionElasticsearchConfig

The Elasticsearch configuration for an Elastic Stack version.

Properties

blacklist (array[string], required)
List of configuration options that cannot be overridden by user settings
capacity_constraints (StackVersionInstanceCapacityConstraint)
The Elasticsearch instance, Kibana instance, APM Server capacity constraints for an Elastic Stack node type.
compatible_node_types (array[string])
Node types that are compatible with this one
default_plugins (array[string], required)
List of default plugins
docker_image (string, required)
Docker image for the Elasticsearch
node_types (array[StackVersionNodeType])
Node types that are supported by this stack version
plugins (array[string], required)
List of available plugins
settings (object)
Settings that are applied to all nodes of this type

Example

{
   "blacklist" : [
      "string"
   ],
   "capacity_constraints" : {
      "max" : 0,
      "min" : 0
   },
   "compatible_node_types" : [
      "string"
   ],
   "default_plugins" : [
      "string"
   ],
   "docker_image" : "string",
   "node_types" : [
      {
         "capacity_constraints" : null,
         "compatible_node_types" : [
            "string"
         ],
         "description" : "string",
         "mandatory" : true,
         "name" : "string",
         "node_type" : "string",
         "settings" : {}
      }
   ],
   "plugins" : [
      "string"
   ],
   "settings" : {}
}

StackVersionInstanceCapacityConstraint

The Elasticsearch instance, Kibana instance, APM Server capacity constraints for an Elastic Stack node type.

Properties

max (integer as int32, required)
Max capacity of the instances
min (integer as int32, required)
Min capacity of the instances

Example

{
   "max" : 0,
   "min" : 0
}

StackVersionKibanaConfig

The Kibana configuration for an Elastic Stack version.

Properties

blacklist (array[string], required)
List of configuration options that cannot be overridden by user settings
capacity_constraints (StackVersionInstanceCapacityConstraint)
The Elasticsearch instance, Kibana instance, APM Server capacity constraints for an Elastic Stack node type.
compatible_node_types (array[string])
Node types that are compatible with this one
docker_image (string, required)
Docker image for the kibana
settings (object)
Settings that are applied to all nodes of this type
version (string)
Version of Kibana

Example

{
   "blacklist" : [
      "string"
   ],
   "capacity_constraints" : {
      "max" : 0,
      "min" : 0
   },
   "compatible_node_types" : [
      "string"
   ],
   "docker_image" : "string",
   "settings" : {},
   "version" : "string"
}

StackVersionMetadata

The metadata for the Elastic Stack.

Properties

min_platform_version (string)
The minimum version of the platform that the stack pack version is compatible with
notes (string)
Notes for administrator
pre_release (boolean)
Indicates that the stack pack version is not GA and is not supposed to be used in production
schema_version (integer as int32)
The schema version of the stack pack version

Example

{
   "min_platform_version" : "string",
   "notes" : "string",
   "pre_release" : true,
   "schema_version" : 0
}

StackVersionNodeType

The configuration for an Elastic Stack node type.

Properties

capacity_constraints (StackVersionInstanceCapacityConstraint)
The Elasticsearch instance, Kibana instance, APM Server capacity constraints for an Elastic Stack node type.
compatible_node_types (array[string])
Node types that are compatible with this one
description (string, required)
Description of the node type
mandatory (boolean)
Flag to specify a node type is mandatory in a cluster's plan
name (string, required)
Name of the node type
node_type (string, required)
Type of the node (master, data, …​)
settings (object)
Settings that are applied to all nodes of this type

Example

{
   "capacity_constraints" : {
      "max" : 0,
      "min" : 0
   },
   "compatible_node_types" : [
      "string"
   ],
   "description" : "string",
   "mandatory" : true,
   "name" : "string",
   "node_type" : "string",
   "settings" : {}
}

StackVersionTemplateFileHash

The template file hash for an Elastic Stack version.

Properties

hash (string, required)
SHA-256 hash of a file
path (string, required)
File path relative to template's root

Example

{
   "hash" : "string",
   "path" : "string"
}

StackVersionTemplateInfo

The template information for an Elastic Stack version.

Properties

hashes (array[StackVersionTemplateFileHash])
Relative paths of files with SHA-256 hashes that contains the template
template_version (string)
Template version

Example

{
   "hashes" : [
      {
         "hash" : "string",
         "path" : "string"
      }
   ],
   "template_version" : "string"
}

TargetElasticsearchCluster

Information about the specified Elasticsearch cluster.

Properties

elasticsearch_id (string, required)
The Elasticsearch cluster Id
links (map[string,Hyperlink])
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation

Example

{
   "elasticsearch_id" : "string",
   "links" : {
      "some_property" : {
         "need_elevated_permissions" : true
      }
   }
}

TermQuery

A query for documents that contain the specified terms in the inverted index.

Properties

value (object, required)
The exact value to query for.

Example

{
   "value" : {}
}

TopologySize

Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

Properties

resource (string; allowed values: [memory, storage], required)
Type of resource
value (integer as int32, required)
Amount of resource

Example

{
   "resource" : "string",
   "value" : 0
}

TransientApmPlanConfiguration

Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.

Properties

plan_configuration (ApmPlanControlConfiguration)
The plan control configuration options for the APM Server.
strategy (PlanStrategy)
The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

Example

{
   "plan_configuration" : {
      "calm_wait_time" : 0,
      "cluster_reboot" : "string",
      "extended_maintenance" : true,
      "timeout" : 0
   },
   "strategy" : {
      "autodetect" : {},
      "grow_and_shrink" : {},
      "rolling" : {
         "allow_inline_resize" : true,
         "group_by" : "string",
         "shard_init_wait_time" : 0,
         "skip_synced_flush" : true
      },
      "rolling_grow_and_shrink" : {}
   }
}

TransientAppSearchPlanConfiguration

Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied

Properties

plan_configuration (AppSearchPlanControlConfiguration)
strategy (PlanStrategy)
The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

Example

{
   "plan_configuration" : {
      "calm_wait_time" : 0,
      "cluster_reboot" : "string",
      "extended_maintenance" : true,
      "move_allocators" : [
         {
            "allocator_down" : true,
            "from" : "string",
            "to" : [
               "string"
            ]
         }
      ],
      "move_instances" : [
         {
            "from" : "string",
            "instance_down" : true,
            "to" : [
               "string"
            ]
         }
      ],
      "preferred_allocators" : [
         "string"
      ],
      "reallocate_instances" : true,
      "timeout" : 0
   },
   "strategy" : {
      "autodetect" : {},
      "grow_and_shrink" : {},
      "rolling" : {
         "allow_inline_resize" : true,
         "group_by" : "string",
         "shard_init_wait_time" : 0,
         "skip_synced_flush" : true
      },
      "rolling_grow_and_shrink" : {}
   }
}

TransientElasticsearchPlanConfiguration

Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.

Properties

cluster_settings_json (object)

If specified, contains transient settings to be applied to an Elasticsearch cluster during changes, default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).

  • indices.store.throttle.max_bytes_per_sec: 150Mb
  • indices.recovery.max_bytes_per_sec: 150Mb
  • cluster.routing.allocation.cluster_concurrent_rebalance: 10
  • cluster.routing.allocation.node_initial_primaries_recoveries: 8
  • cluster.routing.allocation.node_concurrent_incoming_recoveries: 8
plan_configuration (ElasticsearchPlanControlConfiguration)
The configuration settings for the timeout and fallback parameters.
restore_snapshot (RestoreSnapshotConfiguration)
Restores a snapshot from a local or remote repository.
strategy (PlanStrategy)
The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

Example

{
   "cluster_settings_json" : {},
   "plan_configuration" : {
      "calm_wait_time" : 0,
      "cluster_reboot" : "string",
      "extended_maintenance" : true,
      "max_snapshot_age" : 0,
      "max_snapshot_attempts" : 0,
      "skip_snapshot" : true,
      "timeout" : 0
   },
   "restore_snapshot" : {
      "repository_config" : {
         "raw_settings" : {}
      },
      "repository_name" : "string",
      "restore_payload" : {
         "indices" : [
            "string"
         ],
         "raw_settings" : {}
      },
      "snapshot_name" : "string",
      "source_cluster_id" : "string",
      "strategy" : "string"
   },
   "strategy" : {
      "autodetect" : {},
      "grow_and_shrink" : {},
      "rolling" : {
         "allow_inline_resize" : true,
         "group_by" : "string",
         "shard_init_wait_time" : 0,
         "skip_synced_flush" : true
      },
      "rolling_grow_and_shrink" : {}
   }
}

TransientEnterpriseSearchPlanConfiguration

Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied

Properties

plan_configuration (EnterpriseSearchPlanControlConfiguration)
strategy (PlanStrategy)
The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

Example

{
   "plan_configuration" : {
      "calm_wait_time" : 0,
      "cluster_reboot" : "string",
      "extended_maintenance" : true,
      "move_allocators" : [
         {
            "allocator_down" : true,
            "from" : "string",
            "to" : [
               "string"
            ]
         }
      ],
      "move_instances" : [
         {
            "from" : "string",
            "instance_down" : true,
            "to" : [
               "string"
            ]
         }
      ],
      "preferred_allocators" : [
         "string"
      ],
      "reallocate_instances" : true,
      "timeout" : 0
   },
   "strategy" : {
      "autodetect" : {},
      "grow_and_shrink" : {},
      "rolling" : {
         "allow_inline_resize" : true,
         "group_by" : "string",
         "shard_init_wait_time" : 0,
         "skip_synced_flush" : true
      },
      "rolling_grow_and_shrink" : {}
   }
}

TransientKibanaPlanConfiguration

Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.

Properties

plan_configuration (KibanaPlanControlConfiguration)
The configuration settings for the timeout and fallback parameters.
strategy (PlanStrategy)
The options for performing a plan change. Specify only one property each time. The default is grow_and_shrink.

Example

{
   "plan_configuration" : {
      "calm_wait_time" : 0,
      "cluster_reboot" : "string",
      "extended_maintenance" : true,
      "timeout" : 0
   },
   "strategy" : {
      "autodetect" : {},
      "grow_and_shrink" : {},
      "rolling" : {
         "allow_inline_resize" : true,
         "group_by" : "string",
         "shard_init_wait_time" : 0,
         "skip_synced_flush" : true
      },
      "rolling_grow_and_shrink" : {}
   }
}

Updates

Holds diagnostics for existing resources that might be updated

Properties

apm (array[Apm])
Diagnostics for APMs
appsearch (array[AppSearch])
Diagnostics for AppSearches
elasticsearch (array[Elasticsearch])
Diagnostics for Elasticsearch clusters
enterprise_search (array[EnterpriseSearch])
Diagnostics for Enterprise Search resources
kibana (array[Kibana])
Diagnostics for Kibanas

Example

{
   "apm" : [
      {
         "backend_plan" : {},
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "ref_id" : "string"
      }
   ],
   "appsearch" : [
      {
         "backend_plan" : {},
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "ref_id" : "string"
      }
   ],
   "elasticsearch" : [
      {
         "backend_plan" : {},
         "display_name" : "string",
         "ref_id" : "string"
      }
   ],
   "enterprise_search" : [
      {
         "backend_plan" : {},
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "ref_id" : "string"
      }
   ],
   "kibana" : [
      {
         "backend_plan" : {},
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "ref_id" : "string"
      }
   ]
}