Definitionsedit

AbsoluteRefIdedit

A reference to a specific resource of a deployment

Propertiesedit

deployment_id (string, required)
The deployment id
ref_id (string, required)
The reference id of the resource in the given deployment

Exampleedit

{
   "deployment_id" : "string",
   "ref_id" : "string"
}

AccountTrustRelationshipedit

The trust relationship with the clusters of one account.

Propertiesedit

account_id (string, required)
the ID of the Account
trust_all (boolean, required)
If true, all clusters in this account will by default be trusted and the trust_allowlist is ignored.
trust_allowlist (array[string])
The list of clusters to trust. Only used when trust_all is false.

Exampleedit

{
   "account_id" : "string",
   "trust_all" : true,
   "trust_allowlist" : [
      "string"
   ]
}

AllocatorMoveRequestedit

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

Propertiesedit

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)

Exampleedit

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

Apmedit

Holds diagnostics for an APM resource

Propertiesedit

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

Exampleedit

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

ApmConfigurationedit

The configuration options for the APM Server.

Propertiesedit

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.)

Exampleedit

{
   "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"
}

ApmCrudResponseedit

The response to an APM CRUD (create/update-plan) request.

Propertiesedit

apm_id (string)
For an operation creating or updating an APM server, the Id of that server
diagnostics (object)
If the endpoint is called with URL param 'validate_only=true', then this contains advanced debug info (the internal plan representation)
secret_token (string, required)
The secret token for accessing the server

Exampleedit

{
   "apm_id" : "string",
   "diagnostics" : {},
   "secret_token" : "string"
}

ApmInfoedit

The overview information for the APM Server.

Propertiesedit

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.

Exampleedit

{
   "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" : {
         "need_elevated_permissions" : true
      }
   },
   "metadata" : {
      "cloud_id" : "string",
      "endpoint" : "string",
      "last_modified" : "2019-01-01T00:00:00Z",
      "ports" : {
         "http" : 0,
         "https" : 0,
         "transport_passthrough" : 0
      },
      "raw" : {},
      "service_url" : "string",
      "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" : {
                     "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
               }
            ],
            "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" : [
         {
            "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" : {
                        "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
                  }
               ],
               "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"
            }
         }
      ],
      "pending" : {
         "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" : {
                     "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
               }
            ],
            "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"
         }
      }
   },
   "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"
         }
      ]
   }
}

ApmPayloadedit

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

Propertiesedit

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

Exampleedit

{
   "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" : {
               "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
         }
      ],
      "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"
      }
   }
}

ApmPlanedit

The plan for the APM Server.

Propertiesedit

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.

Exampleedit

{
   "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" : {
            "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
      }
   ],
   "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" : {}
      }
   }
}

ApmPlanControlConfigurationedit

The plan control configuration options for the APM Server.

Propertiesedit

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)

Exampleedit

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

ApmPlanInfoedit

Information about the APM Server plan.

Propertiesedit

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

Exampleedit

{
   "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" : {
               "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
         }
      ],
      "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"
   }
}

ApmPlansInfoedit

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

Propertiesedit

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.

Exampleedit

{
   "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" : {
                  "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
            }
         ],
         "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" : [
      {
         "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" : {
                     "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
               }
            ],
            "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"
         }
      }
   ],
   "pending" : {
      "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" : {
                  "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
            }
         ],
         "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"
      }
   }
}

ApmResourceInfoedit

Describes an APM resource belonging to a Deployment

Propertiesedit

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

Exampleedit

{
   "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" : {
            "need_elevated_permissions" : true
         }
      },
      "metadata" : {
         "cloud_id" : "string",
         "endpoint" : "string",
         "last_modified" : "2019-01-01T00:00:00Z",
         "ports" : {
            "http" : 0,
            "https" : 0,
            "transport_passthrough" : 0
         },
         "raw" : {},
         "service_url" : "string",
         "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" : {
                        "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
                  }
               ],
               "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" : [
            {
               "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" : {
                           "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
                     }
                  ],
                  "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"
               }
            }
         ],
         "pending" : {
            "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" : {
                        "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
                  }
               ],
               "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"
            }
         }
      },
      "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"
}

ApmSettingsedit

The settings for the APM Server.

Propertiesedit

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

Exampleedit

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

ApmSubInfoedit

Information about the APM Servers associated with the Elasticsearch cluster.

Propertiesedit

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

Exampleedit

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

ApmSystemSettingsedit

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_.

Propertiesedit

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

Exampleedit

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

ApmTopologyElementedit

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

Propertiesedit

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

Exampleedit

{
   "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
}

AppSearchedit

Holds diagnostics for an AppSearch resource

Propertiesedit

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

Exampleedit

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

AppSearchConfigurationedit

Intentionally left blank

Propertiesedit

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.)

Exampleedit

{
   "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"
}

AppSearchInfoedit

The overview information for the App Search Server.

Propertiesedit

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.

Exampleedit

{
   "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" : {
         "need_elevated_permissions" : true
      }
   },
   "metadata" : {
      "cloud_id" : "string",
      "endpoint" : "string",
      "last_modified" : "2019-01-01T00:00:00Z",
      "ports" : {
         "http" : 0,
         "https" : 0,
         "transport_passthrough" : 0
      },
      "raw" : {},
      "service_url" : "string",
      "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" : {
                     "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
               }
            ],
            "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" : [
         {
            "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" : {
                        "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
                  }
               ],
               "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"
            }
         }
      ],
      "pending" : {
         "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" : {
                     "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
               }
            ],
            "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"
         }
      }
   },
   "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"
         }
      ]
   }
}

AppSearchNodeTypesedit

Node types to enable for an AppSearch instance

Propertiesedit

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

Exampleedit

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

AppSearchPayloadedit

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

Propertiesedit

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)
The plan for the App Search cluster.
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

Exampleedit

{
   "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" : {
               "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
         }
      ],
      "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"
      }
   }
}

AppSearchPlanedit

The plan for the App Search cluster.

Propertiesedit

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

Exampleedit

{
   "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" : {
            "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
      }
   ],
   "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" : {}
      }
   }
}

AppSearchPlanControlConfigurationedit

Intentionally left blank

Propertiesedit

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)

Exampleedit

{
   "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
}

AppSearchPlanInfoedit

Information about the App Search Server plan.

Propertiesedit

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)
The plan for the App Search 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

Exampleedit

{
   "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" : {
               "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
         }
      ],
      "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"
   }
}

AppSearchPlansInfoedit

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

Propertiesedit

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.

Exampleedit

{
   "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" : {
                  "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
            }
         ],
         "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" : [
      {
         "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" : {
                     "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
               }
            ],
            "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"
         }
      }
   ],
   "pending" : {
      "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" : {
                  "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
            }
         ],
         "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"
      }
   }
}

AppSearchResourceInfoedit

Describes an App Search resource belonging to a Deployment

Propertiesedit

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

Exampleedit

{
   "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" : {
            "need_elevated_permissions" : true
         }
      },
      "metadata" : {
         "cloud_id" : "string",
         "endpoint" : "string",
         "last_modified" : "2019-01-01T00:00:00Z",
         "ports" : {
            "http" : 0,
            "https" : 0,
            "transport_passthrough" : 0
         },
         "raw" : {},
         "service_url" : "string",
         "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" : {
                        "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
                  }
               ],
               "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" : [
            {
               "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" : {
                           "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
                     }
                  ],
                  "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"
               }
            }
         ],
         "pending" : {
            "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" : {
                        "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
                  }
               ],
               "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"
            }
         }
      },
      "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"
}

AppSearchSettingsedit

The settings for the App Search.

Propertiesedit

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

Exampleedit

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

AppSearchSubInfoedit

Information about the APM Servers associated with the Elasticsearch cluster.

Propertiesedit

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

Exampleedit

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

AppSearchSystemSettingsedit

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)

Propertiesedit

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

Exampleedit

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

AppSearchTopologyElementedit

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

Propertiesedit

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

Exampleedit

{
   "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
}

AutodetectStrategyConfigedit

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

Exampleedit

{}

BasicFailedReplyedit

Intentionally left blank

Propertiesedit

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

Exampleedit

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

BasicFailedReplyElementedit

Intentionally left blank

Propertiesedit

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

Exampleedit

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

BoolQueryedit

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

Propertiesedit

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])

Exampleedit

{
   "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" : [
      {
         "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" : {}
            }
         }
      }
   ],
   "must_not" : [
      {
         "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" : {}
            }
         }
      }
   ],
   "should" : [
      {
         "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" : {}
            }
         }
      }
   ]
}

ChangeSourceInfoedit

A container for information about the source of a change.

Propertiesedit

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

Exampleedit

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

ClusterCredentialsedit

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

Propertiesedit

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

Exampleedit

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

ClusterCurationSettingsedit

The index curation settings for an Elasticsearch cluster.

Propertiesedit

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

Exampleedit

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

ClusterCurationSpecedit

Specifies the conditions to trigger an Elasticsearch cluster curation.

Propertiesedit

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

Exampleedit

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

ClusterInstanceConfigurationInfoedit

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

Propertiesedit

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

Exampleedit

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

ClusterInstanceDiskInfoedit

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

Propertiesedit

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.

Exampleedit

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

ClusterInstanceInfoedit

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

Propertiesedit

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

Exampleedit

{
   "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"
}

ClusterInstanceMemoryInfoedit

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

Propertiesedit

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

Exampleedit

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

ClusterMetadataInfoedit

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

Propertiesedit

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.
service_url (string)
The full URL to access this deployment resource
version (integer as int32, required)
The resource version number of the cluster metadata

Exampleedit

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

ClusterMetadataPortInfoedit

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

Propertiesedit

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
transport_passthrough (integer as int32, required)
Port where the cluster listens for transport traffic using TLS

Exampleedit

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

ClusterMetadataSettingsedit

The top-level configuration settings for the Elasticsearch cluster.

Propertiesedit

name (string)
The display name of the cluster

Exampleedit

{
   "name" : "string"
}

ClusterPlanStepInfoedit

Information about a step in a plan.

Propertiesedit

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

Exampleedit

{
   "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"
}

ClusterPlanStepLogMessageInfoedit

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

Propertiesedit

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

Exampleedit

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

ClusterSnapshotRetentionedit

Information about the Elasticsearch cluster snapshot retention.

Propertiesedit

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

Exampleedit

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

ClusterSnapshotSettingsedit

The snapshot configuration settings for an Elasticsearch cluster.

Propertiesedit

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.

Exampleedit

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

ClusterSystemAlertedit

Information about a system alert on an Elasticsearch cluster.

Propertiesedit

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

Exampleedit

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

ClusterTopologyInfoedit

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.

Propertiesedit

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)

Exampleedit

{
   "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"
      }
   ]
}

CreateExtensionRequestedit

The body of a request to create a new extension

Propertiesedit

description (string)
The extension description.
download_url (string)
The URL to download the extension archive.
extension_type (string; allowed values: [plugin, bundle], required)
The extension type.
name (string, required)
The extension name. Only ASCII alphanumeric and [_.-] characters allowed
version (string, required)
The Elasticsearch version.

Exampleedit

{
   "description" : "string",
   "download_url" : "string",
   "extension_type" : "string",
   "name" : "string",
   "version" : "string"
}

Createsedit

Holds diagnostics for resources that will be created

Propertiesedit

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

Exampleedit

{
   "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"
      }
   ]
}

CrossClusterSearchInfoedit

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

Propertiesedit

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

Exampleedit

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

CrossClusterSearchSettingsedit

The configuration settings for the cross-cluster search.

Propertiesedit

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

Exampleedit

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

DeploymentCreateMetadataedit

Additional information about the new deployment object.

Propertiesedit

tags (array[MetadataItem])
Arbitrary user-defined metadata associated with this deployment

Exampleedit

{
   "tags" : [
      {
         "key" : "string",
         "value" : "string"
      }
   ]
}

DeploymentCreateRequestedit

A request for creating a new Deployment consisting of multiple clusters

Propertiesedit

metadata (DeploymentCreateMetadata)
Additional information about this deployment
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

Exampleedit

{
   "metadata" : {
      "tags" : [
         {
            "key" : "string",
            "value" : "string"
         }
      ]
   },
   "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" : {
                        "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
                  }
               ],
               "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" : {
                        "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
                  }
               ],
               "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"
               }
            }
         }
      ],
      "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" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              },
                              "mustache_enabled" : true,
                              "painless_enabled" : true,
                              "stored" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              }
                           },
                           "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" : {
                  "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" : {
                           "enabled" : true,
                           "sandbox_mode" : true
                        },
                        "mustache_enabled" : true,
                        "painless_enabled" : true,
                        "stored" : {
                           "enabled" : true,
                           "sandbox_mode" : true
                        }
                     },
                     "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"
               },
               "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
                  },
                  "remote_clusters" : {
                     "resources" : [
                        {
                           "alias" : "string",
                           "deployment_id" : "string",
                           "elasticsearch_ref_id" : "string",
                           "skip_unavailable" : true
                        }
                     ]
                  },
                  "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
               },
               "traffic_filter" : {
                  "rulesets" : [
                     "string"
                  ]
               },
               "trust" : {
                  "accounts" : [
                     {
                        "account_id" : "string",
                        "trust_all" : true,
                        "trust_allowlist" : [
                           "string"
                        ]
                     }
                  ],
                  "external" : [
                     {
                        "trust_all" : true,
                        "trust_allowlist" : [
                           "string"
                        ],
                        "trust_relationship_id" : "string"
                     }
                  ]
               }
            }
         }
      ],
      "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" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "zone_count" : 0
                  }
               ],
               "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"
               },
               "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"
               }
            }
         }
      ]
   },
   "settings" : {
      "ip_filtering_settings" : {
         "rulesets" : [
            "string"
         ]
      },
      "observability" : {
         "logging" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         },
         "metrics" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         }
      },
      "traffic_filter_settings" : {
         "rulesets" : [
            "string"
         ]
      }
   }
}

DeploymentCreateResourcesedit

Describes the resources that will belong to a Deployment

Propertiesedit

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.

Exampleedit

{
   "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" : {
                     "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
               }
            ],
            "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" : {
                     "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
               }
            ],
            "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"
            }
         }
      }
   ],
   "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" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           },
                           "mustache_enabled" : true,
                           "painless_enabled" : true,
                           "stored" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           }
                        },
                        "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" : {
               "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" : {
                        "enabled" : true,
                        "sandbox_mode" : true
                     },
                     "mustache_enabled" : true,
                     "painless_enabled" : true,
                     "stored" : {
                        "enabled" : true,
                        "sandbox_mode" : true
                     }
                  },
                  "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"
            },
            "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
               },
               "remote_clusters" : {
                  "resources" : [
                     {
                        "alias" : "string",
                        "deployment_id" : "string",
                        "elasticsearch_ref_id" : "string",
                        "skip_unavailable" : true
                     }
                  ]
               },
               "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
            },
            "traffic_filter" : {
               "rulesets" : [
                  "string"
               ]
            },
            "trust" : {
               "accounts" : [
                  {
                     "account_id" : "string",
                     "trust_all" : true,
                     "trust_allowlist" : [
                        "string"
                     ]
                  }
               ],
               "external" : [
                  {
                     "trust_all" : true,
                     "trust_allowlist" : [
                        "string"
                     ],
                     "trust_relationship_id" : "string"
                  }
               ]
            }
         }
      }
   ],
   "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" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "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"
            },
            "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"
            }
         }
      }
   ]
}

DeploymentCreateResponseedit

A response returned from the Deployment create endpoint

Propertiesedit

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.

Exampleedit

{
   "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" : [
            {
               "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"
            }
         ]
      }
   },
   "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",
         "warnings" : [
            {
               "code" : "string",
               "message" : "string"
            }
         ]
      }
   ]
}

DeploymentCreateSettingsedit

Additional configuration for the new deployment object.

Propertiesedit

ip_filtering_settings (IpFilteringSettings)
DEPRECATED (Scheduled to be removed in the next major version): The set of rulesets applies to this deployment.
observability (DeploymentObservabilitySettings)
Observability settings for this deployment
traffic_filter_settings (TrafficFilterSettings)
The traffic filter rulesets to apply to this deployment.

Exampleedit

{
   "ip_filtering_settings" : {
      "rulesets" : [
         "string"
      ]
   },
   "observability" : {
      "logging" : {
         "destination" : {
            "deployment_id" : "string",
            "ref_id" : "string"
         }
      },
      "metrics" : {
         "destination" : {
            "deployment_id" : "string",
            "ref_id" : "string"
         }
      }
   },
   "traffic_filter_settings" : {
      "rulesets" : [
         "string"
      ]
   }
}

DeploymentDiagnosticsedit

Describes the diagnostics for a given Deployment-modifying payload

Propertiesedit

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

Exampleedit

{
   "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" : [
         {
            "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"
         }
      ]
   }
}

DeploymentGetResponseedit

Describes a given Deployment

Propertiesedit

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
metadata (DeploymentMetadata)
Additional information about this deployment
name (string, required)
The name of this deployment
observability (DeploymentObservability)
The observability information for this deployment
resources (DeploymentResources, required)
The Resources that belong to this Deployment
settings (DeploymentSettings)
Additional configuration for this Deployment

Exampleedit

{
   "healthy" : true,
   "id" : "string",
   "metadata" : {
      "tags" : [
         {
            "key" : "string",
            "value" : "string"
         }
      ]
   },
   "name" : "string",
   "observability" : {
      "healthy" : true,
      "issues" : [
         {
            "description" : "string",
            "severity" : "string"
         }
      ],
      "logging" : {
         "healthy" : true,
         "issues" : [
            {
               "description" : "string",
               "severity" : "string"
            }
         ],
         "urls" : {
            "some_property" : "string"
         }
      },
      "metrics" : {
         "healthy" : true,
         "issues" : [
            {
               "description" : "string",
               "severity" : "string"
            }
         ],
         "urls" : {
            "some_property" : "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" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "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" : {
                                 "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
                           }
                        ],
                        "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" : [
                     {
                        "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" : {
                                    "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
                              }
                           ],
                           "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"
                        }
                     }
                  ],
                  "pending" : {
                     "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" : {
                                 "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
                           }
                        ],
                        "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"
                     }
                  }
               },
               "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" : {
                  "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" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "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" : {
                                 "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
                           }
                        ],
                        "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" : [
                     {
                        "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" : {
                                    "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
                              }
                           ],
                           "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"
                        }
                     }
                  ],
                  "pending" : {
                     "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" : {
                                 "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
                           }
                        ],
                        "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"
                     }
                  }
               },
               "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"
         }
      ],
      "elasticsearch" : [
         {
            "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" : {
                           "need_elevated_permissions" : true
                        }
                     }
                  }
               ],
               "associated_enterprise_search_clusters" : [
                  {
                     "enabled" : true,
                     "enterprise_search_id" : "string",
                     "links" : {
                        "some_property" : {
                           "need_elevated_permissions" : true
                        }
                     }
                  }
               ],
               "associated_kibana_clusters" : [
                  {
                     "enabled" : true,
                     "kibana_id" : "string",
                     "links" : {
                        "some_property" : {
                           "need_elevated_permissions" : true
                        }
                     }
                  }
               ],
               "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" : [
                        {
                           "description" : "string",
                           "instances" : [
                              "string"
                           ]
                        }
                     ]
                  },
                  "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" : [
                        {
                           "instance_name" : "string",
                           "shard_count" : 0
                        }
                     ]
                  }
               },
               "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" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "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" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       },
                                       "mustache_enabled" : true,
                                       "painless_enabled" : true,
                                       "stored" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       }
                                    },
                                    "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" : {
                           "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" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 },
                                 "mustache_enabled" : true,
                                 "painless_enabled" : true,
                                 "stored" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 }
                              },
                              "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"
                        },
                        "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
                           },
                           "remote_clusters" : {
                              "resources" : [
                                 {
                                    "alias" : "string",
                                    "deployment_id" : "string",
                                    "elasticsearch_ref_id" : "string",
                                    "skip_unavailable" : true
                                 }
                              ]
                           },
                           "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" : [
                     {
                        "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" : {
                                             "enabled" : true,
                                             "sandbox_mode" : true
                                          },
                                          "mustache_enabled" : true,
                                          "painless_enabled" : true,
                                          "stored" : {
                                             "enabled" : true,
                                             "sandbox_mode" : true
                                          }
                                       },
                                       "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" : {
                              "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" : {
                                       "enabled" : true,
                                       "sandbox_mode" : true
                                    },
                                    "mustache_enabled" : true,
                                    "painless_enabled" : true,
                                    "stored" : {
                                       "enabled" : true,
                                       "sandbox_mode" : true
                                    }
                                 },
                                 "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"
                           },
                           "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
                              },
                              "remote_clusters" : {
                                 "resources" : [
                                    {
                                       "alias" : "string",
                                       "deployment_id" : "string",
                                       "elasticsearch_ref_id" : "string",
                                       "skip_unavailable" : true
                                    }
                                 ]
                              },
                              "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"
                        }
                     }
                  ],
                  "pending" : {
                     "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" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       },
                                       "mustache_enabled" : true,
                                       "painless_enabled" : true,
                                       "stored" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       }
                                    },
                                    "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" : {
                           "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" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 },
                                 "mustache_enabled" : true,
                                 "painless_enabled" : true,
                                 "stored" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 }
                              },
                              "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"
                        },
                        "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
                           },
                           "remote_clusters" : {
                              "resources" : [
                                 {
                                    "alias" : "string",
                                    "deployment_id" : "string",
                                    "elasticsearch_ref_id" : "string",
                                    "skip_unavailable" : true
                                 }
                              ]
                           },
                           "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"
                     }
                  }
               },
               "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
                  },
                  "traffic_filter" : {
                     "rulesets" : [
                        "string"
                     ]
                  },
                  "trust" : {
                     "accounts" : [
                        {
                           "account_id" : "string",
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ]
                        }
                     ],
                     "external" : [
                        {
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ],
                           "trust_relationship_id" : "string"
                        }
                     ]
                  }
               },
               "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"
         }
      ],
      "enterprise_search" : [
         {
            "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" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "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" : {
                           "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"
                        },
                        "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" : [
                     {
                        "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" : {
                              "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"
                           },
                           "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"
                        }
                     }
                  ],
                  "pending" : {
                     "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" : {
                           "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"
                        },
                        "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"
                     }
                  }
               },
               "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"
         }
      ],
      "kibana" : [
         {
            "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" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "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" : {
                           "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"
                        },
                        "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" : [
                     {
                        "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" : {
                              "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"
                           },
                           "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"
                        }
                     }
                  ],
                  "pending" : {
                     "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" : {
                           "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"
                        },
                        "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"
                     }
                  }
               },
               "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"
         }
      ]
   },
   "settings" : {
      "ip_filtering_settings" : {
         "rulesets" : [
            "string"
         ]
      },
      "observability" : {
         "logging" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         },
         "metrics" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         }
      },
      "traffic_filter_settings" : {
         "rulesets" : [
            "string"
         ]
      }
   }
}

DeploymentLoggingedit

Logging information for a deployment

Propertiesedit

healthy (boolean, required)
Whether the deployment logging is healthy or not
issues (array[ObservabilityIssue])
Logging health issues for the deployment
urls (map[string,string])
The URLs to view this deployment's logs in Kibana

Exampleedit

{
   "healthy" : true,
   "issues" : [
      {
         "description" : "string",
         "severity" : "string"
      }
   ],
   "urls" : {
      "some_property" : "string"
   }
}

DeploymentLoggingSettingsedit

The logging settings for a deployment

Propertiesedit

destination (AbsoluteRefId, required)
The destination deployment that this deployment's logs will be sent to

Exampleedit

{
   "destination" : {
      "deployment_id" : "string",
      "ref_id" : "string"
   }
}

DeploymentMetadataedit

Additional information about the current deployment object.

Propertiesedit

tags (array[MetadataItem])
Arbitrary user-defined metadata associated with this deployment

Exampleedit

{
   "tags" : [
      {
         "key" : "string",
         "value" : "string"
      }
   ]
}

DeploymentMetricsedit

Metrics information for a deployment

Propertiesedit

healthy (boolean, required)
Whether the deployment metrics are healthy or not
issues (array[ObservabilityIssue])
Metrics health issues for the deployment
urls (map[string,string])
The URLs to view this deployment's metrics in Kibana

Exampleedit

{
   "healthy" : true,
   "issues" : [
      {
         "description" : "string",
         "severity" : "string"
      }
   ],
   "urls" : {
      "some_property" : "string"
   }
}

DeploymentMetricsSettingsedit

The metrics settings for a deployment

Propertiesedit

destination (AbsoluteRefId, required)
The destination deployment that this deployment's metrics will be sent to

Exampleedit

{
   "destination" : {
      "deployment_id" : "string",
      "ref_id" : "string"
   }
}

DeploymentObservabilityedit

Observability information for a deployment

Propertiesedit

healthy (boolean, required)
Whether the deployment observability is healthy or not (one or more of the subsections will have healthy: false)
issues (array[ObservabilityIssue])
General observability health issues for the deployment
logging (DeploymentLogging)
The logging information for the deployment
metrics (DeploymentMetrics)
The metrics information for the deployment

Exampleedit

{
   "healthy" : true,
   "issues" : [
      {
         "description" : "string",
         "severity" : "string"
      }
   ],
   "logging" : {
      "healthy" : true,
      "issues" : [
         {
            "description" : "string",
            "severity" : "string"
         }
      ],
      "urls" : {
         "some_property" : "string"
      }
   },
   "metrics" : {
      "healthy" : true,
      "issues" : [
         {
            "description" : "string",
            "severity" : "string"
         }
      ],
      "urls" : {
         "some_property" : "string"
      }
   }
}

DeploymentObservabilitySettingsedit

The observability settings for a deployment

Propertiesedit

logging (DeploymentLoggingSettings)
The logging settings for the deployment
metrics (DeploymentMetricsSettings)
The metrics settings for the deployment

Exampleedit

{
   "logging" : {
      "destination" : {
         "deployment_id" : "string",
         "ref_id" : "string"
      }
   },
   "metrics" : {
      "destination" : {
         "deployment_id" : "string",
         "ref_id" : "string"
      }
   }
}

DeploymentResourceedit

Data for a deployment resource

Propertiesedit

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.
warnings (array[ReplyWarning])
List of warnings generated from validating resource updates

Exampleedit

{
   "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",
   "warnings" : [
      {
         "code" : "string",
         "message" : "string"
      }
   ]
}

DeploymentResourceCommandResponseedit

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

Propertiesedit

warnings (array[ReplyWarning])
List of warnings generated from validating command

Exampleedit

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

DeploymentResourceCrudResponseedit

A response returned from the Deployment Resource endpoints

Propertiesedit

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

Exampleedit

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

DeploymentResourceUpgradeResponseedit

Intentionally left blank

Propertiesedit

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

Exampleedit

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

DeploymentResourcesedit

Describes a resource belonging to a Deployment

Propertiesedit

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

Exampleedit

{
   "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" : {
                  "need_elevated_permissions" : true
               }
            },
            "metadata" : {
               "cloud_id" : "string",
               "endpoint" : "string",
               "last_modified" : "2019-01-01T00:00:00Z",
               "ports" : {
                  "http" : 0,
                  "https" : 0,
                  "transport_passthrough" : 0
               },
               "raw" : {},
               "service_url" : "string",
               "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" : {
                              "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
                        }
                     ],
                     "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" : [
                  {
                     "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" : {
                                 "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
                           }
                        ],
                        "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"
                     }
                  }
               ],
               "pending" : {
                  "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" : {
                              "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
                        }
                     ],
                     "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"
                  }
               }
            },
            "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" : {
               "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" : {
                  "need_elevated_permissions" : true
               }
            },
            "metadata" : {
               "cloud_id" : "string",
               "endpoint" : "string",
               "last_modified" : "2019-01-01T00:00:00Z",
               "ports" : {
                  "http" : 0,
                  "https" : 0,
                  "transport_passthrough" : 0
               },
               "raw" : {},
               "service_url" : "string",
               "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" : {
                              "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
                        }
                     ],
                     "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" : [
                  {
                     "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" : {
                                 "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
                           }
                        ],
                        "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"
                     }
                  }
               ],
               "pending" : {
                  "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" : {
                              "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
                        }
                     ],
                     "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"
                  }
               }
            },
            "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"
      }
   ],
   "elasticsearch" : [
      {
         "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" : {
                        "need_elevated_permissions" : true
                     }
                  }
               }
            ],
            "associated_enterprise_search_clusters" : [
               {
                  "enabled" : true,
                  "enterprise_search_id" : "string",
                  "links" : {
                     "some_property" : {
                        "need_elevated_permissions" : true
                     }
                  }
               }
            ],
            "associated_kibana_clusters" : [
               {
                  "enabled" : true,
                  "kibana_id" : "string",
                  "links" : {
                     "some_property" : {
                        "need_elevated_permissions" : true
                     }
                  }
               }
            ],
            "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" : [
                     {
                        "description" : "string",
                        "instances" : [
                           "string"
                        ]
                     }
                  ]
               },
               "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" : [
                     {
                        "instance_name" : "string",
                        "shard_count" : 0
                     }
                  ]
               }
            },
            "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" : {
                  "need_elevated_permissions" : true
               }
            },
            "metadata" : {
               "cloud_id" : "string",
               "endpoint" : "string",
               "last_modified" : "2019-01-01T00:00:00Z",
               "ports" : {
                  "http" : 0,
                  "https" : 0,
                  "transport_passthrough" : 0
               },
               "raw" : {},
               "service_url" : "string",
               "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" : {
                                       "enabled" : true,
                                       "sandbox_mode" : true
                                    },
                                    "mustache_enabled" : true,
                                    "painless_enabled" : true,
                                    "stored" : {
                                       "enabled" : true,
                                       "sandbox_mode" : true
                                    }
                                 },
                                 "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" : {
                        "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" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              },
                              "mustache_enabled" : true,
                              "painless_enabled" : true,
                              "stored" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              }
                           },
                           "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"
                     },
                     "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
                        },
                        "remote_clusters" : {
                           "resources" : [
                              {
                                 "alias" : "string",
                                 "deployment_id" : "string",
                                 "elasticsearch_ref_id" : "string",
                                 "skip_unavailable" : true
                              }
                           ]
                        },
                        "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" : [
                  {
                     "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" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       },
                                       "mustache_enabled" : true,
                                       "painless_enabled" : true,
                                       "stored" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       }
                                    },
                                    "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" : {
                           "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" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 },
                                 "mustache_enabled" : true,
                                 "painless_enabled" : true,
                                 "stored" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 }
                              },
                              "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"
                        },
                        "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
                           },
                           "remote_clusters" : {
                              "resources" : [
                                 {
                                    "alias" : "string",
                                    "deployment_id" : "string",
                                    "elasticsearch_ref_id" : "string",
                                    "skip_unavailable" : true
                                 }
                              ]
                           },
                           "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"
                     }
                  }
               ],
               "pending" : {
                  "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" : {
                                       "enabled" : true,
                                       "sandbox_mode" : true
                                    },
                                    "mustache_enabled" : true,
                                    "painless_enabled" : true,
                                    "stored" : {
                                       "enabled" : true,
                                       "sandbox_mode" : true
                                    }
                                 },
                                 "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" : {
                        "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" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              },
                              "mustache_enabled" : true,
                              "painless_enabled" : true,
                              "stored" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              }
                           },
                           "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"
                     },
                     "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
                        },
                        "remote_clusters" : {
                           "resources" : [
                              {
                                 "alias" : "string",
                                 "deployment_id" : "string",
                                 "elasticsearch_ref_id" : "string",
                                 "skip_unavailable" : true
                              }
                           ]
                        },
                        "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"
                  }
               }
            },
            "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
               },
               "traffic_filter" : {
                  "rulesets" : [
                     "string"
                  ]
               },
               "trust" : {
                  "accounts" : [
                     {
                        "account_id" : "string",
                        "trust_all" : true,
                        "trust_allowlist" : [
                           "string"
                        ]
                     }
                  ],
                  "external" : [
                     {
                        "trust_all" : true,
                        "trust_allowlist" : [
                           "string"
                        ],
                        "trust_relationship_id" : "string"
                     }
                  ]
               }
            },
            "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"
      }
   ],
   "enterprise_search" : [
      {
         "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" : {
                  "need_elevated_permissions" : true
               }
            },
            "metadata" : {
               "cloud_id" : "string",
               "endpoint" : "string",
               "last_modified" : "2019-01-01T00:00:00Z",
               "ports" : {
                  "http" : 0,
                  "https" : 0,
                  "transport_passthrough" : 0
               },
               "raw" : {},
               "service_url" : "string",
               "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" : {
                        "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"
                     },
                     "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" : [
                  {
                     "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" : {
                           "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"
                        },
                        "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"
                     }
                  }
               ],
               "pending" : {
                  "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" : {
                        "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"
                     },
                     "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"
                  }
               }
            },
            "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"
      }
   ],
   "kibana" : [
      {
         "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" : {
                  "need_elevated_permissions" : true
               }
            },
            "metadata" : {
               "cloud_id" : "string",
               "endpoint" : "string",
               "last_modified" : "2019-01-01T00:00:00Z",
               "ports" : {
                  "http" : 0,
                  "https" : 0,
                  "transport_passthrough" : 0
               },
               "raw" : {},
               "service_url" : "string",
               "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" : {
                        "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"
                     },
                     "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" : [
                  {
                     "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" : {
                           "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"
                        },
                        "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"
                     }
                  }
               ],
               "pending" : {
                  "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" : {
                        "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"
                     },
                     "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"
                  }
               }
            },
            "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"
      }
   ]
}

DeploymentRestoreResponseedit

A response returned from the Deployment restore endpoint

Propertiesedit

id (string, required)
The id of the deployment

Exampleedit

{
   "id" : "string"
}

DeploymentSearchResponseedit

Describes a searched Deployment

Propertiesedit

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
metadata (DeploymentMetadata)
Additional information about 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

Exampleedit

{
   "healthy" : true,
   "id" : "string",
   "metadata" : {
      "tags" : [
         {
            "key" : "string",
            "value" : "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" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "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" : {
                                 "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
                           }
                        ],
                        "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" : [
                     {
                        "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" : {
                                    "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
                              }
                           ],
                           "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"
                        }
                     }
                  ],
                  "pending" : {
                     "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" : {
                                 "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
                           }
                        ],
                        "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"
                     }
                  }
               },
               "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" : {
                  "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" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "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" : {
                                 "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
                           }
                        ],
                        "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" : [
                     {
                        "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" : {
                                    "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
                              }
                           ],
                           "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"
                        }
                     }
                  ],
                  "pending" : {
                     "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" : {
                                 "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
                           }
                        ],
                        "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"
                     }
                  }
               },
               "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"
         }
      ],
      "elasticsearch" : [
         {
            "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" : {
                           "need_elevated_permissions" : true
                        }
                     }
                  }
               ],
               "associated_enterprise_search_clusters" : [
                  {
                     "enabled" : true,
                     "enterprise_search_id" : "string",
                     "links" : {
                        "some_property" : {
                           "need_elevated_permissions" : true
                        }
                     }
                  }
               ],
               "associated_kibana_clusters" : [
                  {
                     "enabled" : true,
                     "kibana_id" : "string",
                     "links" : {
                        "some_property" : {
                           "need_elevated_permissions" : true
                        }
                     }
                  }
               ],
               "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" : [
                        {
                           "description" : "string",
                           "instances" : [
                              "string"
                           ]
                        }
                     ]
                  },
                  "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" : [
                        {
                           "instance_name" : "string",
                           "shard_count" : 0
                        }
                     ]
                  }
               },
               "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" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "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" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       },
                                       "mustache_enabled" : true,
                                       "painless_enabled" : true,
                                       "stored" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       }
                                    },
                                    "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" : {
                           "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" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 },
                                 "mustache_enabled" : true,
                                 "painless_enabled" : true,
                                 "stored" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 }
                              },
                              "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"
                        },
                        "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
                           },
                           "remote_clusters" : {
                              "resources" : [
                                 {
                                    "alias" : "string",
                                    "deployment_id" : "string",
                                    "elasticsearch_ref_id" : "string",
                                    "skip_unavailable" : true
                                 }
                              ]
                           },
                           "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" : [
                     {
                        "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" : {
                                             "enabled" : true,
                                             "sandbox_mode" : true
                                          },
                                          "mustache_enabled" : true,
                                          "painless_enabled" : true,
                                          "stored" : {
                                             "enabled" : true,
                                             "sandbox_mode" : true
                                          }
                                       },
                                       "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" : {
                              "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" : {
                                       "enabled" : true,
                                       "sandbox_mode" : true
                                    },
                                    "mustache_enabled" : true,
                                    "painless_enabled" : true,
                                    "stored" : {
                                       "enabled" : true,
                                       "sandbox_mode" : true
                                    }
                                 },
                                 "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"
                           },
                           "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
                              },
                              "remote_clusters" : {
                                 "resources" : [
                                    {
                                       "alias" : "string",
                                       "deployment_id" : "string",
                                       "elasticsearch_ref_id" : "string",
                                       "skip_unavailable" : true
                                    }
                                 ]
                              },
                              "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"
                        }
                     }
                  ],
                  "pending" : {
                     "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" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       },
                                       "mustache_enabled" : true,
                                       "painless_enabled" : true,
                                       "stored" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       }
                                    },
                                    "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" : {
                           "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" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 },
                                 "mustache_enabled" : true,
                                 "painless_enabled" : true,
                                 "stored" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 }
                              },
                              "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"
                        },
                        "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
                           },
                           "remote_clusters" : {
                              "resources" : [
                                 {
                                    "alias" : "string",
                                    "deployment_id" : "string",
                                    "elasticsearch_ref_id" : "string",
                                    "skip_unavailable" : true
                                 }
                              ]
                           },
                           "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"
                     }
                  }
               },
               "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
                  },
                  "traffic_filter" : {
                     "rulesets" : [
                        "string"
                     ]
                  },
                  "trust" : {
                     "accounts" : [
                        {
                           "account_id" : "string",
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ]
                        }
                     ],
                     "external" : [
                        {
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ],
                           "trust_relationship_id" : "string"
                        }
                     ]
                  }
               },
               "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"
         }
      ],
      "enterprise_search" : [
         {
            "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" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "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" : {
                           "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"
                        },
                        "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" : [
                     {
                        "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" : {
                              "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"
                           },
                           "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"
                        }
                     }
                  ],
                  "pending" : {
                     "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" : {
                           "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"
                        },
                        "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"
                     }
                  }
               },
               "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"
         }
      ],
      "kibana" : [
         {
            "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" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "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" : {
                           "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"
                        },
                        "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" : [
                     {
                        "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" : {
                              "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"
                           },
                           "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"
                        }
                     }
                  ],
                  "pending" : {
                     "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" : {
                           "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"
                        },
                        "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"
                     }
                  }
               },
               "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"
         }
      ]
   },
   "settings" : {
      "ip_filtering_settings" : {
         "rulesets" : [
            "string"
         ]
      },
      "observability" : {
         "logging" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         },
         "metrics" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         }
      },
      "traffic_filter_settings" : {
         "rulesets" : [
            "string"
         ]
      }
   }
}

DeploymentSettingsedit

Additional configuration about the current deployment object.

Propertiesedit

ip_filtering_settings (IpFilteringSettings)
DEPRECATED The set of IP filtering rulesets applies to this deployment.
observability (DeploymentObservabilitySettings)
Logging and monitoring settings for this deployment
traffic_filter_settings (TrafficFilterSettings)
The traffic filter rulesets for this deployment.

Exampleedit

{
   "ip_filtering_settings" : {
      "rulesets" : [
         "string"
      ]
   },
   "observability" : {
      "logging" : {
         "destination" : {
            "deployment_id" : "string",
            "ref_id" : "string"
         }
      },
      "metrics" : {
         "destination" : {
            "deployment_id" : "string",
            "ref_id" : "string"
         }
      }
   },
   "traffic_filter_settings" : {
      "rulesets" : [
         "string"
      ]
   }
}

DeploymentShutdownResponseedit

A response returned from the Deployment shutdown endpoint

Propertiesedit

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

Exampleedit

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

DeploymentTemplateInfoV2edit

Deployment template detailed information

Propertiesedit

deployment_template (DeploymentCreateRequest, required)
The body of the deployment template to use for creating a deployment.
description (string)
An optional description for the template.
id (string, required)
The unique identifier for the template.
instance_configurations (array[InstanceConfigurationInfo], required)
List of instance configurations used in the cluster template.
kibana_deeplink (array[KibanaDeeplink])
The Kibana Deeplink for this type of deployment.
metadata (array[MetadataItem])
Optional arbitrary metadata to associate with this template.
min_version (string)
Minimum stack version required by this template, if any.
name (string, required)
A human readable name for the template.
order (integer as int32)
Determines the order in which this template should be returned when listed. Templates are returned in ascending order. If not specified, then the template willbe appended to the end of the list.
source (ChangeSourceInfo)
Information describing the source that created or modified the template.
system_owned (boolean)
Whether or not if this is system owned template.
template_category_id (string)
Provider and version agnostic template identifier used for grouping related template types.

Exampleedit

{
   "deployment_template" : {
      "metadata" : {
         "tags" : [
            {
               "key" : "string",
               "value" : "string"
            }
         ]
      },
      "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" : {
                           "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
                     }
                  ],
                  "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" : {
                           "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
                     }
                  ],
                  "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"
                  }
               }
            }
         ],
         "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" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 },
                                 "mustache_enabled" : true,
                                 "painless_enabled" : true,
                                 "stored" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 }
                              },
                              "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" : {
                     "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" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           },
                           "mustache_enabled" : true,
                           "painless_enabled" : true,
                           "stored" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           }
                        },
                        "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"
                  },
                  "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
                     },
                     "remote_clusters" : {
                        "resources" : [
                           {
                              "alias" : "string",
                              "deployment_id" : "string",
                              "elasticsearch_ref_id" : "string",
                              "skip_unavailable" : true
                           }
                        ]
                     },
                     "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
                  },
                  "traffic_filter" : {
                     "rulesets" : [
                        "string"
                     ]
                  },
                  "trust" : {
                     "accounts" : [
                        {
                           "account_id" : "string",
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ]
                        }
                     ],
                     "external" : [
                        {
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ],
                           "trust_relationship_id" : "string"
                        }
                     ]
                  }
               }
            }
         ],
         "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" : {
                           "resource" : "string",
                           "value" : 0
                        },
                        "zone_count" : 0
                     }
                  ],
                  "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"
                  },
                  "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"
                  }
               }
            }
         ]
      },
      "settings" : {
         "ip_filtering_settings" : {
            "rulesets" : [
               "string"
            ]
         },
         "observability" : {
            "logging" : {
               "destination" : {
                  "deployment_id" : "string",
                  "ref_id" : "string"
               }
            },
            "metrics" : {
               "destination" : {
                  "deployment_id" : "string",
                  "ref_id" : "string"
               }
            }
         },
         "traffic_filter_settings" : {
            "rulesets" : [
               "string"
            ]
         }
      }
   },
   "description" : "string",
   "id" : "string",
   "instance_configurations" : [
      {
         "description" : "string",
         "discrete_sizes" : {
            "default_size" : 0,
            "resource" : "string",
            "sizes" : [
               0
            ]
         },
         "id" : "string",
         "instance_type" : "string",
         "name" : "string",
         "node_types" : [
            "string"
         ],
         "storage_multiplier" : 0.1
      }
   ],
   "kibana_deeplink" : [
      {
         "semver" : "string",
         "uri" : "string"
      }
   ],
   "metadata" : [
      {
         "key" : "string",
         "value" : "string"
      }
   ],
   "min_version" : "string",
   "name" : "string",
   "order" : 0,
   "source" : {
      "action" : "string",
      "admin_id" : "string",
      "date" : "2019-01-01T00:00:00Z",
      "facilitator" : "string",
      "remote_addresses" : [
         "string"
      ],
      "user_id" : "string"
   },
   "system_owned" : true,
   "template_category_id" : "string"
}

DeploymentTemplateMigrateResponseedit

A response returned from the Deployment migrate endpoint

Propertiesedit

resources (DeploymentUpdateRequest, required)
Resources that are part of the deployment after the migrate operation.

Exampleedit

{
   "resources" : {
      "metadata" : {
         "tags" : [
            {
               "key" : "string",
               "value" : "string"
            }
         ]
      },
      "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" : {
                           "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
                     }
                  ],
                  "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" : {
                           "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
                     }
                  ],
                  "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"
                  }
               }
            }
         ],
         "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" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 },
                                 "mustache_enabled" : true,
                                 "painless_enabled" : true,
                                 "stored" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 }
                              },
                              "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" : {
                     "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" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           },
                           "mustache_enabled" : true,
                           "painless_enabled" : true,
                           "stored" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           }
                        },
                        "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"
                  },
                  "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
                     },
                     "remote_clusters" : {
                        "resources" : [
                           {
                              "alias" : "string",
                              "deployment_id" : "string",
                              "elasticsearch_ref_id" : "string",
                              "skip_unavailable" : true
                           }
                        ]
                     },
                     "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
                  },
                  "traffic_filter" : {
                     "rulesets" : [
                        "string"
                     ]
                  },
                  "trust" : {
                     "accounts" : [
                        {
                           "account_id" : "string",
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ]
                        }
                     ],
                     "external" : [
                        {
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ],
                           "trust_relationship_id" : "string"
                        }
                     ]
                  }
               }
            }
         ],
         "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" : {
                           "resource" : "string",
                           "value" : 0
                        },
                        "zone_count" : 0
                     }
                  ],
                  "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"
                  },
                  "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"
                  }
               }
            }
         ]
      },
      "settings" : {
         "observability" : {
            "logging" : {
               "destination" : {
                  "deployment_id" : "string",
                  "ref_id" : "string"
               }
            },
            "metrics" : {
               "destination" : {
                  "deployment_id" : "string",
                  "ref_id" : "string"
               }
            }
         }
      }
   }
}

DeploymentTemplateReferenceedit

Specifies the deployment template used to create the plan.

Propertiesedit

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

Exampleedit

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

DeploymentUpdateMetadataedit

Additional information about the current deployment object.

Propertiesedit

tags (array[MetadataItem])
Arbitrary user-defined metadata associated with this deployment

Exampleedit

{
   "tags" : [
      {
         "key" : "string",
         "value" : "string"
      }
   ]
}

DeploymentUpdateRequestedit

A request for updating a Deployment consisting of multiple resources

Propertiesedit

metadata (DeploymentUpdateMetadata)
Any new information about the current deployment object. If there is no new information the value is unchanged.
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
settings (DeploymentUpdateSettings)
Any new configuration for the current deployment object. If there is no new configuration the value is unchanged.

Exampleedit

{
   "metadata" : {
      "tags" : [
         {
            "key" : "string",
            "value" : "string"
         }
      ]
   },
   "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" : {
                        "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
                  }
               ],
               "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" : {
                        "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
                  }
               ],
               "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"
               }
            }
         }
      ],
      "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" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              },
                              "mustache_enabled" : true,
                              "painless_enabled" : true,
                              "stored" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              }
                           },
                           "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" : {
                  "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" : {
                           "enabled" : true,
                           "sandbox_mode" : true
                        },
                        "mustache_enabled" : true,
                        "painless_enabled" : true,
                        "stored" : {
                           "enabled" : true,
                           "sandbox_mode" : true
                        }
                     },
                     "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"
               },
               "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
                  },
                  "remote_clusters" : {
                     "resources" : [
                        {
                           "alias" : "string",
                           "deployment_id" : "string",
                           "elasticsearch_ref_id" : "string",
                           "skip_unavailable" : true
                        }
                     ]
                  },
                  "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
               },
               "traffic_filter" : {
                  "rulesets" : [
                     "string"
                  ]
               },
               "trust" : {
                  "accounts" : [
                     {
                        "account_id" : "string",
                        "trust_all" : true,
                        "trust_allowlist" : [
                           "string"
                        ]
                     }
                  ],
                  "external" : [
                     {
                        "trust_all" : true,
                        "trust_allowlist" : [
                           "string"
                        ],
                        "trust_relationship_id" : "string"
                     }
                  ]
               }
            }
         }
      ],
      "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" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "zone_count" : 0
                  }
               ],
               "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"
               },
               "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"
               }
            }
         }
      ]
   },
   "settings" : {
      "observability" : {
         "logging" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         },
         "metrics" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         }
      }
   }
}

DeploymentUpdateResourcesedit

Describes the resources that will have the Deployment

Propertiesedit

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

Exampleedit

{
   "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" : {
                     "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
               }
            ],
            "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" : {
                     "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
               }
            ],
            "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"
            }
         }
      }
   ],
   "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" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           },
                           "mustache_enabled" : true,
                           "painless_enabled" : true,
                           "stored" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           }
                        },
                        "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" : {
               "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" : {
                        "enabled" : true,
                        "sandbox_mode" : true
                     },
                     "mustache_enabled" : true,
                     "painless_enabled" : true,
                     "stored" : {
                        "enabled" : true,
                        "sandbox_mode" : true
                     }
                  },
                  "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"
            },
            "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
               },
               "remote_clusters" : {
                  "resources" : [
                     {
                        "alias" : "string",
                        "deployment_id" : "string",
                        "elasticsearch_ref_id" : "string",
                        "skip_unavailable" : true
                     }
                  ]
               },
               "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
            },
            "traffic_filter" : {
               "rulesets" : [
                  "string"
               ]
            },
            "trust" : {
               "accounts" : [
                  {
                     "account_id" : "string",
                     "trust_all" : true,
                     "trust_allowlist" : [
                        "string"
                     ]
                  }
               ],
               "external" : [
                  {
                     "trust_all" : true,
                     "trust_allowlist" : [
                        "string"
                     ],
                     "trust_relationship_id" : "string"
                  }
               ]
            }
         }
      }
   ],
   "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" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "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"
            },
            "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"
            }
         }
      }
   ]
}

DeploymentUpdateResponseedit

A response returned from the Deployment update endpoint

Propertiesedit

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

Exampleedit

{
   "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" : [
            {
               "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"
            }
         ]
      }
   },
   "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",
         "warnings" : [
            {
               "code" : "string",
               "message" : "string"
            }
         ]
      }
   ],
   "shutdown_resources" : {
      "apm" : [
         "string"
      ],
      "appsearch" : [
         "string"
      ],
      "elasticsearch" : [
         {
            "dependents" : [
               {
                  "id" : "string",
                  "kind" : "string"
               }
            ],
            "id" : "string"
         }
      ],
      "enterprise_search" : [
         "string"
      ],
      "kibana" : [
         "string"
      ]
   }
}

DeploymentUpdateSettingsedit

Additional configuration for the new deployment object.

Propertiesedit

observability (DeploymentObservabilitySettings)
Logging and monitoring settings for this deployment. If provided it will change observability settings, if null observability will be removed from the deployment, otherwise will stay the same

Exampleedit

{
   "observability" : {
      "logging" : {
         "destination" : {
            "deployment_id" : "string",
            "ref_id" : "string"
         }
      },
      "metrics" : {
         "destination" : {
            "deployment_id" : "string",
            "ref_id" : "string"
         }
      }
   }
}

DeploymentsListResponseedit

Contains a list of deployments

Propertiesedit

deployments (array[DeploymentsListingData], required)
The deployments

Exampleedit

{
   "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",
               "warnings" : [
                  {
                     "code" : "string",
                     "message" : "string"
                  }
               ]
            }
         ]
      }
   ]
}

DeploymentsListingDataedit

Intentionally left blank

Propertiesedit

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

Exampleedit

{
   "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",
         "warnings" : [
            {
               "code" : "string",
               "message" : "string"
            }
         ]
      }
   ]
}

DeploymentsSearchResponseedit

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

Propertiesedit

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

Exampleedit

{
   "deployments" : [
      {
         "healthy" : true,
         "id" : "string",
         "metadata" : {
            "tags" : [
               {
                  "key" : "string",
                  "value" : "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" : {
                           "need_elevated_permissions" : true
                        }
                     },
                     "metadata" : {
                        "cloud_id" : "string",
                        "endpoint" : "string",
                        "last_modified" : "2019-01-01T00:00:00Z",
                        "ports" : {
                           "http" : 0,
                           "https" : 0,
                           "transport_passthrough" : 0
                        },
                        "raw" : {},
                        "service_url" : "string",
                        "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" : {
                                       "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
                                 }
                              ],
                              "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" : [
                           {
                              "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" : {
                                          "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
                                    }
                                 ],
                                 "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"
                              }
                           }
                        ],
                        "pending" : {
                           "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" : {
                                       "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
                                 }
                              ],
                              "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"
                           }
                        }
                     },
                     "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" : {
                        "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" : {
                           "need_elevated_permissions" : true
                        }
                     },
                     "metadata" : {
                        "cloud_id" : "string",
                        "endpoint" : "string",
                        "last_modified" : "2019-01-01T00:00:00Z",
                        "ports" : {
                           "http" : 0,
                           "https" : 0,
                           "transport_passthrough" : 0
                        },
                        "raw" : {},
                        "service_url" : "string",
                        "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" : {
                                       "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
                                 }
                              ],
                              "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" : [
                           {
                              "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" : {
                                          "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
                                    }
                                 ],
                                 "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"
                              }
                           }
                        ],
                        "pending" : {
                           "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" : {
                                       "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
                                 }
                              ],
                              "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"
                           }
                        }
                     },
                     "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"
               }
            ],
            "elasticsearch" : [
               {
                  "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" : {
                                 "need_elevated_permissions" : true
                              }
                           }
                        }
                     ],
                     "associated_enterprise_search_clusters" : [
                        {
                           "enabled" : true,
                           "enterprise_search_id" : "string",
                           "links" : {
                              "some_property" : {
                                 "need_elevated_permissions" : true
                              }
                           }
                        }
                     ],
                     "associated_kibana_clusters" : [
                        {
                           "enabled" : true,
                           "kibana_id" : "string",
                           "links" : {
                              "some_property" : {
                                 "need_elevated_permissions" : true
                              }
                           }
                        }
                     ],
                     "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" : [
                              {
                                 "description" : "string",
                                 "instances" : [
                                    "string"
                                 ]
                              }
                           ]
                        },
                        "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" : [
                              {
                                 "instance_name" : "string",
                                 "shard_count" : 0
                              }
                           ]
                        }
                     },
                     "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" : {
                           "need_elevated_permissions" : true
                        }
                     },
                     "metadata" : {
                        "cloud_id" : "string",
                        "endpoint" : "string",
                        "last_modified" : "2019-01-01T00:00:00Z",
                        "ports" : {
                           "http" : 0,
                           "https" : 0,
                           "transport_passthrough" : 0
                        },
                        "raw" : {},
                        "service_url" : "string",
                        "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" : {
                                                "enabled" : true,
                                                "sandbox_mode" : true
                                             },
                                             "mustache_enabled" : true,
                                             "painless_enabled" : true,
                                             "stored" : {
                                                "enabled" : true,
                                                "sandbox_mode" : true
                                             }
                                          },
                                          "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" : {
                                 "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" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       },
                                       "mustache_enabled" : true,
                                       "painless_enabled" : true,
                                       "stored" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       }
                                    },
                                    "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"
                              },
                              "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
                                 },
                                 "remote_clusters" : {
                                    "resources" : [
                                       {
                                          "alias" : "string",
                                          "deployment_id" : "string",
                                          "elasticsearch_ref_id" : "string",
                                          "skip_unavailable" : true
                                       }
                                    ]
                                 },
                                 "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" : [
                           {
                              "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" : {
                                                   "enabled" : true,
                                                   "sandbox_mode" : true
                                                },
                                                "mustache_enabled" : true,
                                                "painless_enabled" : true,
                                                "stored" : {
                                                   "enabled" : true,
                                                   "sandbox_mode" : true
                                                }
                                             },
                                             "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" : {
                                    "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" : {
                                             "enabled" : true,
                                             "sandbox_mode" : true
                                          },
                                          "mustache_enabled" : true,
                                          "painless_enabled" : true,
                                          "stored" : {
                                             "enabled" : true,
                                             "sandbox_mode" : true
                                          }
                                       },
                                       "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"
                                 },
                                 "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
                                    },
                                    "remote_clusters" : {
                                       "resources" : [
                                          {
                                             "alias" : "string",
                                             "deployment_id" : "string",
                                             "elasticsearch_ref_id" : "string",
                                             "skip_unavailable" : true
                                          }
                                       ]
                                    },
                                    "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"
                              }
                           }
                        ],
                        "pending" : {
                           "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" : {
                                                "enabled" : true,
                                                "sandbox_mode" : true
                                             },
                                             "mustache_enabled" : true,
                                             "painless_enabled" : true,
                                             "stored" : {
                                                "enabled" : true,
                                                "sandbox_mode" : true
                                             }
                                          },
                                          "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" : {
                                 "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" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       },
                                       "mustache_enabled" : true,
                                       "painless_enabled" : true,
                                       "stored" : {
                                          "enabled" : true,
                                          "sandbox_mode" : true
                                       }
                                    },
                                    "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"
                              },
                              "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
                                 },
                                 "remote_clusters" : {
                                    "resources" : [
                                       {
                                          "alias" : "string",
                                          "deployment_id" : "string",
                                          "elasticsearch_ref_id" : "string",
                                          "skip_unavailable" : true
                                       }
                                    ]
                                 },
                                 "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"
                           }
                        }
                     },
                     "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
                        },
                        "traffic_filter" : {
                           "rulesets" : [
                              "string"
                           ]
                        },
                        "trust" : {
                           "accounts" : [
                              {
                                 "account_id" : "string",
                                 "trust_all" : true,
                                 "trust_allowlist" : [
                                    "string"
                                 ]
                              }
                           ],
                           "external" : [
                              {
                                 "trust_all" : true,
                                 "trust_allowlist" : [
                                    "string"
                                 ],
                                 "trust_relationship_id" : "string"
                              }
                           ]
                        }
                     },
                     "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"
               }
            ],
            "enterprise_search" : [
               {
                  "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" : {
                           "need_elevated_permissions" : true
                        }
                     },
                     "metadata" : {
                        "cloud_id" : "string",
                        "endpoint" : "string",
                        "last_modified" : "2019-01-01T00:00:00Z",
                        "ports" : {
                           "http" : 0,
                           "https" : 0,
                           "transport_passthrough" : 0
                        },
                        "raw" : {},
                        "service_url" : "string",
                        "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" : {
                                 "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"
                              },
                              "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" : [
                           {
                              "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" : {
                                    "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"
                                 },
                                 "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"
                              }
                           }
                        ],
                        "pending" : {
                           "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" : {
                                 "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"
                              },
                              "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"
                           }
                        }
                     },
                     "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"
               }
            ],
            "kibana" : [
               {
                  "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" : {
                           "need_elevated_permissions" : true
                        }
                     },
                     "metadata" : {
                        "cloud_id" : "string",
                        "endpoint" : "string",
                        "last_modified" : "2019-01-01T00:00:00Z",
                        "ports" : {
                           "http" : 0,
                           "https" : 0,
                           "transport_passthrough" : 0
                        },
                        "raw" : {},
                        "service_url" : "string",
                        "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" : {
                                 "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"
                              },
                              "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" : [
                           {
                              "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" : {
                                    "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"
                                 },
                                 "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"
                              }
                           }
                        ],
                        "pending" : {
                           "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" : {
                                 "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"
                              },
                              "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"
                           }
                        }
                     },
                     "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"
               }
            ]
         },
         "settings" : {
            "ip_filtering_settings" : {
               "rulesets" : [
                  "string"
               ]
            },
            "observability" : {
               "logging" : {
                  "destination" : {
                     "deployment_id" : "string",
                     "ref_id" : "string"
                  }
               },
               "metrics" : {
                  "destination" : {
                     "deployment_id" : "string",
                     "ref_id" : "string"
                  }
               }
            },
            "traffic_filter_settings" : {
               "rulesets" : [
                  "string"
               ]
            }
         }
      }
   ],
   "match_count" : 0,
   "return_count" : 0
}

DiscreteSizesedit

Instance sizes that are supported by the Elasticsearch instance, Kibana instance, or APM Server configuration.

Propertiesedit

default_size (integer as int32, required)
The default size
resource (string; allowed values: [memory, storage], required)
The unit that each size represents
sizes (array[integer], required)
List of supported sizes

Exampleedit

{
   "default_size" : 0,
   "resource" : "string",
   "sizes" : [
      0
   ]
}

Elasticsearchedit

Holds diagnostics for an Elasticsearch cluster

Propertiesedit

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

Exampleedit

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

ElasticsearchClusterBlockingIssueElementedit

Information about an issue and the Elasticsearch instance it affects.

Propertiesedit

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

Exampleedit

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

ElasticsearchClusterBlockingIssuesedit

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

Propertiesedit

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

Exampleedit

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

ElasticsearchClusterInfoedit

The information for an Elasticsearch cluster.

Propertiesedit

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.

Exampleedit

{
   "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" : {
               "need_elevated_permissions" : true
            }
         }
      }
   ],
   "associated_enterprise_search_clusters" : [
      {
         "enabled" : true,
         "enterprise_search_id" : "string",
         "links" : {
            "some_property" : {
               "need_elevated_permissions" : true
            }
         }
      }
   ],
   "associated_kibana_clusters" : [
      {
         "enabled" : true,
         "kibana_id" : "string",
         "links" : {
            "some_property" : {
               "need_elevated_permissions" : true
            }
         }
      }
   ],
   "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" : [
            {
               "description" : "string",
               "instances" : [
                  "string"
               ]
            }
         ]
      },
      "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" : [
            {
               "instance_name" : "string",
               "shard_count" : 0
            }
         ]
      }
   },
   "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" : {
         "need_elevated_permissions" : true
      }
   },
   "metadata" : {
      "cloud_id" : "string",
      "endpoint" : "string",
      "last_modified" : "2019-01-01T00:00:00Z",
      "ports" : {
         "http" : 0,
         "https" : 0,
         "transport_passthrough" : 0
      },
      "raw" : {},
      "service_url" : "string",
      "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" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           },
                           "mustache_enabled" : true,
                           "painless_enabled" : true,
                           "stored" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           }
                        },
                        "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" : {
               "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" : {
                        "enabled" : true,
                        "sandbox_mode" : true
                     },
                     "mustache_enabled" : true,
                     "painless_enabled" : true,
                     "stored" : {
                        "enabled" : true,
                        "sandbox_mode" : true
                     }
                  },
                  "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"
            },
            "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
               },
               "remote_clusters" : {
                  "resources" : [
                     {
                        "alias" : "string",
                        "deployment_id" : "string",
                        "elasticsearch_ref_id" : "string",
                        "skip_unavailable" : true
                     }
                  ]
               },
               "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" : [
         {
            "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" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              },
                              "mustache_enabled" : true,
                              "painless_enabled" : true,
                              "stored" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              }
                           },
                           "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" : {
                  "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" : {
                           "enabled" : true,
                           "sandbox_mode" : true
                        },
                        "mustache_enabled" : true,
                        "painless_enabled" : true,
                        "stored" : {
                           "enabled" : true,
                           "sandbox_mode" : true
                        }
                     },
                     "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"
               },
               "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
                  },
                  "remote_clusters" : {
                     "resources" : [
                        {
                           "alias" : "string",
                           "deployment_id" : "string",
                           "elasticsearch_ref_id" : "string",