Definitions

edit

AccountResponse

edit

An account is the entity that owns deployments, and it is accessed by users. Accounts are isolated from each other.

Properties

edit
id (string, required)
The account's identifier
trust (AccountTrustSettings)
Settings related to the level of trust of the clusters in this account

Example

edit
{
   "id" : "string",
   "trust" : {
      "trust_all" : true
   }
}

AccountTrustRelationship

edit

The trust relationship with the clusters of one account.

Properties

edit
account_id (string, required)
the ID of the Account
name (string)
A human readable name of the trust relationship
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.

Example

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

AccountTrustSettings

edit

Settings related to the level of trust of the clusters in this account

Properties

edit
trust_all (boolean, required)
If true, all clusters in this account will by default trust all other clusters in the same account

Example

edit
{
   "trust_all" : true
}

AccountUpdateRequest

edit

A request to update an account

Properties

edit
trust (AccountTrustSettings)
Settings related to the level of trust of the clusters in this account

Example

edit
{
   "trust" : {
      "trust_all" : true
   }
}

AllocatorMoveRequest

edit

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

Properties

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

Example

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

ApiKeyResponse

edit

The response model for an API key.

Properties

edit
creation_date (string as date-time, required)
The date/time for when the API key is created.
description (string, required)
The API key description. TIP: Useful when you have multiple API keys.
expiration_date (string as date-time)
The date/time when the API key expires.
id (string, required)
The API key ID.
key (string)
The API key. TIP: Since the API key is returned only once, save it in a safe place.
organization_id (string)
The organization ID linked to the API key
role_assignments (RoleAssignments)
The optional roles for the API key. Currently unavailable in self-hosted ECE.
user_id (string)
The user ID.

Example

edit
{
   "creation_date" : "2019-01-01T00:00:00Z",
   "description" : "string",
   "expiration_date" : "2019-01-01T00:00:00Z",
   "id" : "string",
   "key" : "string",
   "organization_id" : "string",
   "role_assignments" : {
      "deployment" : [
         {
            "all" : true,
            "application_roles" : [
               "string"
            ],
            "deployment_ids" : [
               "string"
            ],
            "organization_id" : "string",
            "role_id" : "string"
         }
      ],
      "organization" : [
         {
            "organization_id" : "string",
            "role_id" : "string"
         }
      ],
      "platform" : [
         {
            "role_id" : "string"
         }
      ],
      "project" : {
         "elasticsearch" : [
            {
               "all" : true,
               "application_roles" : [
                  "string"
               ],
               "organization_id" : "string",
               "project_ids" : [
                  "string"
               ],
               "role_id" : "string"
            }
         ],
         "observability" : [
            {
               "all" : true,
               "application_roles" : [
                  "string"
               ],
               "organization_id" : "string",
               "project_ids" : [
                  "string"
               ],
               "role_id" : "string"
            }
         ],
         "security" : [
            {
               "all" : true,
               "application_roles" : [
                  "string"
               ],
               "organization_id" : "string",
               "project_ids" : [
                  "string"
               ],
               "role_id" : "string"
            }
         ]
      }
   },
   "user_id" : "string"
}

ApiKeysResponse

edit

The response model for the API keys.

Properties

edit
keys (array[ApiKeyResponse], required)
The list of API keys.

Example

edit
{
   "keys" : [
      {
         "creation_date" : "2019-01-01T00:00:00Z",
         "description" : "string",
         "expiration_date" : "2019-01-01T00:00:00Z",
         "id" : "string",
         "key" : "string",
         "organization_id" : "string",
         "role_assignments" : {
            "deployment" : [
               {
                  "all" : true,
                  "application_roles" : [
                     "string"
                  ],
                  "deployment_ids" : [
                     "string"
                  ],
                  "organization_id" : "string",
                  "role_id" : "string"
               }
            ],
            "organization" : [
               {
                  "organization_id" : "string",
                  "role_id" : "string"
               }
            ],
            "platform" : [
               {
                  "role_id" : "string"
               }
            ],
            "project" : {
               "elasticsearch" : [
                  {
                     "all" : true,
                     "application_roles" : [
                        "string"
                     ],
                     "organization_id" : "string",
                     "project_ids" : [
                        "string"
                     ],
                     "role_id" : "string"
                  }
               ],
               "observability" : [
                  {
                     "all" : true,
                     "application_roles" : [
                        "string"
                     ],
                     "organization_id" : "string",
                     "project_ids" : [
                        "string"
                     ],
                     "role_id" : "string"
                  }
               ],
               "security" : [
                  {
                     "all" : true,
                     "application_roles" : [
                        "string"
                     ],
                     "organization_id" : "string",
                     "project_ids" : [
                        "string"
                     ],
                     "role_id" : "string"
                  }
               ]
            }
         },
         "user_id" : "string"
      }
   ]
}

Apm

edit

Holds diagnostics for an APM resource

Properties

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

Example

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

ApmConfiguration

edit

The configuration options for the APM Server.

Properties

edit
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 the parameters are on the allowlist and not on the denylist. (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 the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
version (string)
The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)

Example

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

ApmCrudResponse

edit

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

Properties

edit
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

Example

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

ApmInfo

edit

The overview information for the APM Server.

Properties

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

Example

edit
{
   "apm_server_mode" : "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,
   "id" : "string",
   "links" : {
      "some_property" : {
         "need_elevated_permissions" : true
      }
   },
   "metadata" : {
      "aliased_endpoint" : "string",
      "aliased_url" : "string",
      "cloud_id" : "string",
      "endpoint" : "string",
      "last_modified" : "2019-01-01T00:00:00Z",
      "ports" : {
         "http" : 0,
         "https" : 0,
         "transport_passthrough" : 0
      },
      "raw" : {},
      "service_url" : "string",
      "services_urls" : [
         {
            "service" : "string",
            "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",
         "error" : {
            "details" : {
               "some_property" : "string"
            },
            "failure_type" : "string",
            "message" : "string",
            "timestamp" : "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",
                  "instance_configuration_version" : 0,
                  "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,
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "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"
         },
         "warnings" : [
            {
               "code" : "string",
               "message" : "string",
               "step_id" : "string"
            }
         ]
      },
      "healthy" : true,
      "history" : [
         {
            "attempt_end_time" : "2019-01-01T00:00:00Z",
            "attempt_start_time" : "2019-01-01T00:00:00Z",
            "error" : {
               "details" : {
                  "some_property" : "string"
               },
               "failure_type" : "string",
               "message" : "string",
               "timestamp" : "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",
                     "instance_configuration_version" : 0,
                     "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,
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "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"
            },
            "warnings" : [
               {
                  "code" : "string",
                  "message" : "string",
                  "step_id" : "string"
               }
            ]
         }
      ],
      "pending" : {
         "attempt_end_time" : "2019-01-01T00:00:00Z",
         "attempt_start_time" : "2019-01-01T00:00:00Z",
         "error" : {
            "details" : {
               "some_property" : "string"
            },
            "failure_type" : "string",
            "message" : "string",
            "timestamp" : "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",
                  "instance_configuration_version" : 0,
                  "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,
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "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"
         },
         "warnings" : [
            {
               "code" : "string",
               "message" : "string",
               "step_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" : {
               "config_version" : 0,
               "id" : "string",
               "name" : "string",
               "resource" : "string"
            },
            "instance_name" : "string",
            "instance_overrides" : {
               "capacity" : 0,
               "storage_multiplier" : 0.1
            },
            "maintenance_mode" : true,
            "memory" : {
               "instance_capacity" : 0,
               "instance_capacity_planned" : 0,
               "memory_pressure" : 0,
               "native_memory_pressure" : 0
            },
            "node_roles" : [
               "string"
            ],
            "service_roles" : [
               "string"
            ],
            "service_running" : true,
            "service_version" : "string",
            "zone" : "string"
         }
      ]
   }
}

ApmPayload

edit

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

Properties

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

Example

edit
{
   "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",
            "instance_configuration_version" : 0,
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "transient" : {
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "timeout" : 0
         },
         "strategy" : {
            "autodetect" : {},
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   },
   "ref_id" : "string",
   "region" : "string",
   "settings" : {
      "metadata" : {
         "name" : "string"
      }
   }
}

ApmPlan

edit

The plan for the APM Server.

Properties

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

Example

edit
{
   "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",
         "instance_configuration_version" : 0,
         "size" : {
            "resource" : "string",
            "value" : 0
         },
         "zone_count" : 0
      }
   ],
   "transient" : {
      "plan_configuration" : {
         "calm_wait_time" : 0,
         "cluster_reboot" : "string",
         "extended_maintenance" : true,
         "timeout" : 0
      },
      "strategy" : {
         "autodetect" : {},
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   }
}

ApmPlanControlConfiguration

edit

The plan control configuration options for the APM Server.

Properties

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

Example

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

ApmPlanInfo

edit

Information about the APM Server plan.

Properties

edit
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)
error (ClusterPlanAttemptError)
Information about an error during a plan attempt.
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
warnings (array[ClusterPlanWarning], required)

Example

edit
{
   "attempt_end_time" : "2019-01-01T00:00:00Z",
   "attempt_start_time" : "2019-01-01T00:00:00Z",
   "error" : {
      "details" : {
         "some_property" : "string"
      },
      "failure_type" : "string",
      "message" : "string",
      "timestamp" : "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",
            "instance_configuration_version" : 0,
            "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,
               "details" : {
                  "some_property" : "string"
               },
               "failure_type" : "string",
               "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"
   },
   "warnings" : [
      {
         "code" : "string",
         "message" : "string",
         "step_id" : "string"
      }
   ]
}

ApmPlansInfo

edit

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

Properties

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

Example

edit
{
   "current" : {
      "attempt_end_time" : "2019-01-01T00:00:00Z",
      "attempt_start_time" : "2019-01-01T00:00:00Z",
      "error" : {
         "details" : {
            "some_property" : "string"
         },
         "failure_type" : "string",
         "message" : "string",
         "timestamp" : "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",
               "instance_configuration_version" : 0,
               "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,
                  "details" : {
                     "some_property" : "string"
                  },
                  "failure_type" : "string",
                  "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"
      },
      "warnings" : [
         {
            "code" : "string",
            "message" : "string",
            "step_id" : "string"
         }
      ]
   },
   "healthy" : true,
   "history" : [
      {
         "attempt_end_time" : "2019-01-01T00:00:00Z",
         "attempt_start_time" : "2019-01-01T00:00:00Z",
         "error" : {
            "details" : {
               "some_property" : "string"
            },
            "failure_type" : "string",
            "message" : "string",
            "timestamp" : "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",
                  "instance_configuration_version" : 0,
                  "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,
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "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"
         },
         "warnings" : [
            {
               "code" : "string",
               "message" : "string",
               "step_id" : "string"
            }
         ]
      }
   ],
   "pending" : {
      "attempt_end_time" : "2019-01-01T00:00:00Z",
      "attempt_start_time" : "2019-01-01T00:00:00Z",
      "error" : {
         "details" : {
            "some_property" : "string"
         },
         "failure_type" : "string",
         "message" : "string",
         "timestamp" : "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",
               "instance_configuration_version" : 0,
               "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,
                  "details" : {
                     "some_property" : "string"
                  },
                  "failure_type" : "string",
                  "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"
      },
      "warnings" : [
         {
            "code" : "string",
            "message" : "string",
            "step_id" : "string"
         }
      ]
   }
}

ApmResourceInfo

edit

Describes an APM resource belonging to a Deployment

Properties

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

Example

edit
{
   "elasticsearch_cluster_ref_id" : "string",
   "id" : "string",
   "info" : {
      "apm_server_mode" : "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,
      "id" : "string",
      "links" : {
         "some_property" : {
            "need_elevated_permissions" : true
         }
      },
      "metadata" : {
         "aliased_endpoint" : "string",
         "aliased_url" : "string",
         "cloud_id" : "string",
         "endpoint" : "string",
         "last_modified" : "2019-01-01T00:00:00Z",
         "ports" : {
            "http" : 0,
            "https" : 0,
            "transport_passthrough" : 0
         },
         "raw" : {},
         "service_url" : "string",
         "services_urls" : [
            {
               "service" : "string",
               "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",
            "error" : {
               "details" : {
                  "some_property" : "string"
               },
               "failure_type" : "string",
               "message" : "string",
               "timestamp" : "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",
                     "instance_configuration_version" : 0,
                     "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,
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "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"
            },
            "warnings" : [
               {
                  "code" : "string",
                  "message" : "string",
                  "step_id" : "string"
               }
            ]
         },
         "healthy" : true,
         "history" : [
            {
               "attempt_end_time" : "2019-01-01T00:00:00Z",
               "attempt_start_time" : "2019-01-01T00:00:00Z",
               "error" : {
                  "details" : {
                     "some_property" : "string"
                  },
                  "failure_type" : "string",
                  "message" : "string",
                  "timestamp" : "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",
                        "instance_configuration_version" : 0,
                        "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,
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "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"
               },
               "warnings" : [
                  {
                     "code" : "string",
                     "message" : "string",
                     "step_id" : "string"
                  }
               ]
            }
         ],
         "pending" : {
            "attempt_end_time" : "2019-01-01T00:00:00Z",
            "attempt_start_time" : "2019-01-01T00:00:00Z",
            "error" : {
               "details" : {
                  "some_property" : "string"
               },
               "failure_type" : "string",
               "message" : "string",
               "timestamp" : "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",
                     "instance_configuration_version" : 0,
                     "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,
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "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"
            },
            "warnings" : [
               {
                  "code" : "string",
                  "message" : "string",
                  "step_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" : {
                  "config_version" : 0,
                  "id" : "string",
                  "name" : "string",
                  "resource" : "string"
               },
               "instance_name" : "string",
               "instance_overrides" : {
                  "capacity" : 0,
                  "storage_multiplier" : 0.1
               },
               "maintenance_mode" : true,
               "memory" : {
                  "instance_capacity" : 0,
                  "instance_capacity_planned" : 0,
                  "memory_pressure" : 0,
                  "native_memory_pressure" : 0
               },
               "node_roles" : [
                  "string"
               ],
               "service_roles" : [
                  "string"
               ],
               "service_running" : true,
               "service_version" : "string",
               "zone" : "string"
            }
         ]
      }
   },
   "ref_id" : "string",
   "region" : "string"
}

ApmSettings

edit

The settings for the APM Server.

Properties

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

Example

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

ApmSubInfo

edit

Information about the APM Servers associated with the Elasticsearch cluster.

Properties

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

Example

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

ApmSystemSettings

edit

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

Properties

edit
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). Note that this field is never returned from the API, it is write only.
elasticsearch_url (string)
DEPRECATED: Scheduled for removal in a future version of the API. 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). Note that this field is never returned from the API, it is write only.
kibana_url (string)
DEPRECATED: Scheduled for removal in a future version of the API. Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
secret_token (string)
Optionally override the secret token within APM - defaults to the previously existing secretToken

Example

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

ApmTopologyElement

edit

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

Properties

edit
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.
instance_configuration_version (integer as int32)
The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version&#39
and for deployment updates, it is equivalent to 'retain the current version'.
size (TopologySize)
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
zone_count (integer as int32)
number of zones in which nodes will be placed

Example

edit
{
   "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",
   "instance_configuration_version" : 0,
   "size" : {
      "resource" : "string",
      "value" : 0
   },
   "zone_count" : 0
}

AppSearch

edit

Holds diagnostics for an AppSearch resource

Properties

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

Example

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

AppSearchConfiguration

edit

Intentionally left blank

Properties

edit
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 the parameters are on the allowlist and not on the denylist. (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 the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings)
version (string)
The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.)

Example

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

AppSearchInfo

edit

The overview information for the App Search Server.

Properties

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

Example

edit
{
   "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" : {
      "aliased_endpoint" : "string",
      "aliased_url" : "string",
      "cloud_id" : "string",
      "endpoint" : "string",
      "last_modified" : "2019-01-01T00:00:00Z",
      "ports" : {
         "http" : 0,
         "https" : 0,
         "transport_passthrough" : 0
      },
      "raw" : {},
      "service_url" : "string",
      "services_urls" : [
         {
            "service" : "string",
            "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",
         "error" : {
            "details" : {
               "some_property" : "string"
            },
            "failure_type" : "string",
            "message" : "string",
            "timestamp" : "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",
                  "instance_configuration_version" : 0,
                  "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,
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "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"
         },
         "warnings" : [
            {
               "code" : "string",
               "message" : "string",
               "step_id" : "string"
            }
         ]
      },
      "healthy" : true,
      "history" : [
         {
            "attempt_end_time" : "2019-01-01T00:00:00Z",
            "attempt_start_time" : "2019-01-01T00:00:00Z",
            "error" : {
               "details" : {
                  "some_property" : "string"
               },
               "failure_type" : "string",
               "message" : "string",
               "timestamp" : "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",
                     "instance_configuration_version" : 0,
                     "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,
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "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"
            },
            "warnings" : [
               {
                  "code" : "string",
                  "message" : "string",
                  "step_id" : "string"
               }
            ]
         }
      ],
      "pending" : {
         "attempt_end_time" : "2019-01-01T00:00:00Z",
         "attempt_start_time" : "2019-01-01T00:00:00Z",
         "error" : {
            "details" : {
               "some_property" : "string"
            },
            "failure_type" : "string",
            "message" : "string",
            "timestamp" : "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",
                  "instance_configuration_version" : 0,
                  "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,
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "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"
         },
         "warnings" : [
            {
               "code" : "string",
               "message" : "string",
               "step_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" : {
               "config_version" : 0,
               "id" : "string",
               "name" : "string",
               "resource" : "string"
            },
            "instance_name" : "string",
            "instance_overrides" : {
               "capacity" : 0,
               "storage_multiplier" : 0.1
            },
            "maintenance_mode" : true,
            "memory" : {
               "instance_capacity" : 0,
               "instance_capacity_planned" : 0,
               "memory_pressure" : 0,
               "native_memory_pressure" : 0
            },
            "node_roles" : [
               "string"
            ],
            "service_roles" : [
               "string"
            ],
            "service_running" : true,
            "service_version" : "string",
            "zone" : "string"
         }
      ]
   }
}

AppSearchNodeTypes

edit

Node types to enable for an AppSearch instance

Properties

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

Example

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

AppSearchPayload

edit

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

Properties

edit
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

Example

edit
{
   "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",
            "instance_configuration_version" : 0,
            "node_type" : {
               "appserver" : true,
               "worker" : true
            },
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "transient" : {
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "move_allocators" : [
               {
                  "allocator_down" : true,
                  "from" : "string",
                  "to" : [
                     "string"
                  ]
               }
            ],
            "move_instances" : [
               {
                  "from" : "string",
                  "instance_down" : true,
                  "to" : [
                     "string"
                  ]
               }
            ],
            "preferred_allocators" : [
               "string"
            ],
            "reallocate_instances" : true,
            "timeout" : 0
         },
         "strategy" : {
            "autodetect" : {},
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   },
   "ref_id" : "string",
   "region" : "string",
   "settings" : {
      "metadata" : {
         "name" : "string"
      }
   }
}

AppSearchPlan

edit

The plan for the App Search cluster.

Properties

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

Example

edit
{
   "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",
         "instance_configuration_version" : 0,
         "node_type" : {
            "appserver" : true,
            "worker" : true
         },
         "size" : {
            "resource" : "string",
            "value" : 0
         },
         "zone_count" : 0
      }
   ],
   "transient" : {
      "plan_configuration" : {
         "calm_wait_time" : 0,
         "cluster_reboot" : "string",
         "extended_maintenance" : true,
         "move_allocators" : [
            {
               "allocator_down" : true,
               "from" : "string",
               "to" : [
                  "string"
               ]
            }
         ],
         "move_instances" : [
            {
               "from" : "string",
               "instance_down" : true,
               "to" : [
                  "string"
               ]
            }
         ],
         "preferred_allocators" : [
            "string"
         ],
         "reallocate_instances" : true,
         "timeout" : 0
      },
      "strategy" : {
         "autodetect" : {},
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   }
}

AppSearchPlanControlConfiguration

edit

Intentionally left blank

Properties

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

Example

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

AppSearchPlanInfo

edit

Information about the App Search Server plan.

Properties

edit
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)
error (ClusterPlanAttemptError)
Information about an error during a plan attempt.
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
warnings (array[ClusterPlanWarning], required)

Example

edit
{
   "attempt_end_time" : "2019-01-01T00:00:00Z",
   "attempt_start_time" : "2019-01-01T00:00:00Z",
   "error" : {
      "details" : {
         "some_property" : "string"
      },
      "failure_type" : "string",
      "message" : "string",
      "timestamp" : "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",
            "instance_configuration_version" : 0,
            "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,
               "details" : {
                  "some_property" : "string"
               },
               "failure_type" : "string",
               "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"
   },
   "warnings" : [
      {
         "code" : "string",
         "message" : "string",
         "step_id" : "string"
      }
   ]
}

AppSearchPlansInfo

edit

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

Properties

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

Example

edit
{
   "current" : {
      "attempt_end_time" : "2019-01-01T00:00:00Z",
      "attempt_start_time" : "2019-01-01T00:00:00Z",
      "error" : {
         "details" : {
            "some_property" : "string"
         },
         "failure_type" : "string",
         "message" : "string",
         "timestamp" : "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",
               "instance_configuration_version" : 0,
               "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,
                  "details" : {
                     "some_property" : "string"
                  },
                  "failure_type" : "string",
                  "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"
      },
      "warnings" : [
         {
            "code" : "string",
            "message" : "string",
            "step_id" : "string"
         }
      ]
   },
   "healthy" : true,
   "history" : [
      {
         "attempt_end_time" : "2019-01-01T00:00:00Z",
         "attempt_start_time" : "2019-01-01T00:00:00Z",
         "error" : {
            "details" : {
               "some_property" : "string"
            },
            "failure_type" : "string",
            "message" : "string",
            "timestamp" : "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",
                  "instance_configuration_version" : 0,
                  "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,
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "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"
         },
         "warnings" : [
            {
               "code" : "string",
               "message" : "string",
               "step_id" : "string"
            }
         ]
      }
   ],
   "pending" : {
      "attempt_end_time" : "2019-01-01T00:00:00Z",
      "attempt_start_time" : "2019-01-01T00:00:00Z",
      "error" : {
         "details" : {
            "some_property" : "string"
         },
         "failure_type" : "string",
         "message" : "string",
         "timestamp" : "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",
               "instance_configuration_version" : 0,
               "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,
                  "details" : {
                     "some_property" : "string"
                  },
                  "failure_type" : "string",
                  "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"
      },
      "warnings" : [
         {
            "code" : "string",
            "message" : "string",
            "step_id" : "string"
         }
      ]
   }
}

AppSearchResourceInfo

edit

Describes an App Search resource belonging to a Deployment

Properties

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

Example

edit
{
   "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" : {
         "aliased_endpoint" : "string",
         "aliased_url" : "string",
         "cloud_id" : "string",
         "endpoint" : "string",
         "last_modified" : "2019-01-01T00:00:00Z",
         "ports" : {
            "http" : 0,
            "https" : 0,
            "transport_passthrough" : 0
         },
         "raw" : {},
         "service_url" : "string",
         "services_urls" : [
            {
               "service" : "string",
               "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",
            "error" : {
               "details" : {
                  "some_property" : "string"
               },
               "failure_type" : "string",
               "message" : "string",
               "timestamp" : "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",
                     "instance_configuration_version" : 0,
                     "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,
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "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"
            },
            "warnings" : [
               {
                  "code" : "string",
                  "message" : "string",
                  "step_id" : "string"
               }
            ]
         },
         "healthy" : true,
         "history" : [
            {
               "attempt_end_time" : "2019-01-01T00:00:00Z",
               "attempt_start_time" : "2019-01-01T00:00:00Z",
               "error" : {
                  "details" : {
                     "some_property" : "string"
                  },
                  "failure_type" : "string",
                  "message" : "string",
                  "timestamp" : "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",
                        "instance_configuration_version" : 0,
                        "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,
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "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"
               },
               "warnings" : [
                  {
                     "code" : "string",
                     "message" : "string",
                     "step_id" : "string"
                  }
               ]
            }
         ],
         "pending" : {
            "attempt_end_time" : "2019-01-01T00:00:00Z",
            "attempt_start_time" : "2019-01-01T00:00:00Z",
            "error" : {
               "details" : {
                  "some_property" : "string"
               },
               "failure_type" : "string",
               "message" : "string",
               "timestamp" : "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",
                     "instance_configuration_version" : 0,
                     "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,
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "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"
            },
            "warnings" : [
               {
                  "code" : "string",
                  "message" : "string",
                  "step_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" : {
                  "config_version" : 0,
                  "id" : "string",
                  "name" : "string",
                  "resource" : "string"
               },
               "instance_name" : "string",
               "instance_overrides" : {
                  "capacity" : 0,
                  "storage_multiplier" : 0.1
               },
               "maintenance_mode" : true,
               "memory" : {
                  "instance_capacity" : 0,
                  "instance_capacity_planned" : 0,
                  "memory_pressure" : 0,
                  "native_memory_pressure" : 0
               },
               "node_roles" : [
                  "string"
               ],
               "service_roles" : [
                  "string"
               ],
               "service_running" : true,
               "service_version" : "string",
               "zone" : "string"
            }
         ]
      }
   },
   "ref_id" : "string",
   "region" : "string"
}

AppSearchSettings

edit

The settings for the App Search.

Properties

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

Example

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

AppSearchSubInfo

edit

Information about the APM Servers associated with the Elasticsearch cluster.

Properties

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

Example

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

AppSearchSystemSettings

edit

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

Properties

edit
elasticsearch_password (string)
Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
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 App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
secret_session_key (string)
Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only.

Example

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

AppSearchTopologyElement

edit

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

Properties

edit
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.
instance_configuration_version (integer as int32)
The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version&#39
and for deployment updates, it is equivalent to 'retain the current version'.
node_type (AppSearchNodeTypes)
Defines the AppSearch node type
size (TopologySize)
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
zone_count (integer as int32)
number of zones in which nodes will be placed

Example

edit
{
   "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",
   "instance_configuration_version" : 0,
   "node_type" : {
      "appserver" : true,
      "worker" : true
   },
   "size" : {
      "resource" : "string",
      "value" : 0
   },
   "zone_count" : 0
}

AutoOpsSettings

edit

AutoOps settings for this deployment.

Properties

edit
status (string; allowed values: [connected, not_connected, excluded], required)
See AutoOps integration status for this deployment.

Example

edit
{
   "status" : "string"
}

AutodetectStrategyConfig

edit

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

Example

edit
{}

Balance

edit

The available balance for an organization

Properties

edit
available (number as double, required)
Available balance
line_items (array[SimplifiedLineItem], required)
A collection of order line items for for an organization
remaining (number as double, required)
Remaining balance

Example

edit
{
   "available" : 0.1,
   "line_items" : [
      {
         "ecu_balance" : 0.1,
         "ecu_quantity" : 0.1,
         "end" : "2019-01-01T00:00:00Z",
         "id" : "string",
         "start" : "2019-01-01T00:00:00Z"
      }
   ],
   "remaining" : 0.1
}

BasicFailedReply

edit

Intentionally left blank

Properties

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

Example

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

BasicFailedReplyElement

edit

Intentionally left blank

Properties

edit
code (string, required)
A structured code representing the error type that occurred
fields (array[string])
If the error can be tied to a specific field or fields in the user request, this lists those fields
message (string, required)
A human readable message describing the error that occurred

Example

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

BoolQuery

edit

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

Properties

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

Example

edit
{
   "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"
            }
         },
         "simple_query_string" : {
            "analyze_wildcard" : true,
            "analyzer" : "string",
            "auto_generate_synonyms_phrase_query" : true,
            "default_operator" : "string",
            "fields" : [
               "string"
            ],
            "flags" : "string",
            "fuzzy_max_expansions" : 0,
            "fuzzy_prefix_length" : 0,
            "fuzzy_transpositions" : true,
            "lenient" : true,
            "minimum_should_match" : "string",
            "query" : "string",
            "quote_field_suffix" : "string"
         },
         "term" : {
            "some_property" : {
               "value" : "string"
            }
         }
      }
   ],
   "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"
            }
         },
         "simple_query_string" : {
            "analyze_wildcard" : true,
            "analyzer" : "string",
            "auto_generate_synonyms_phrase_query" : true,
            "default_operator" : "string",
            "fields" : [
               "string"
            ],
            "flags" : "string",
            "fuzzy_max_expansions" : 0,
            "fuzzy_prefix_length" : 0,
            "fuzzy_transpositions" : true,
            "lenient" : true,
            "minimum_should_match" : "string",
            "query" : "string",
            "quote_field_suffix" : "string"
         },
         "term" : {
            "some_property" : {
               "value" : "string"
            }
         }
      }
   ],
   "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"
            }
         },
         "simple_query_string" : {
            "analyze_wildcard" : true,
            "analyzer" : "string",
            "auto_generate_synonyms_phrase_query" : true,
            "default_operator" : "string",
            "fields" : [
               "string"
            ],
            "flags" : "string",
            "fuzzy_max_expansions" : 0,
            "fuzzy_prefix_length" : 0,
            "fuzzy_transpositions" : true,
            "lenient" : true,
            "minimum_should_match" : "string",
            "query" : "string",
            "quote_field_suffix" : "string"
         },
         "term" : {
            "some_property" : {
               "value" : "string"
            }
         }
      }
   ],
   "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"
            }
         },
         "simple_query_string" : {
            "analyze_wildcard" : true,
            "analyzer" : "string",
            "auto_generate_synonyms_phrase_query" : true,
            "default_operator" : "string",
            "fields" : [
               "string"
            ],
            "flags" : "string",
            "fuzzy_max_expansions" : 0,
            "fuzzy_prefix_length" : 0,
            "fuzzy_transpositions" : true,
            "lenient" : true,
            "minimum_should_match" : "string",
            "query" : "string",
            "quote_field_suffix" : "string"
         },
         "term" : {
            "some_property" : {
               "value" : "string"
            }
         }
      }
   ]
}

CertificateAuthority

edit

The certificate authority used to sign the certificates of this deployment

Properties

edit
public_certificates (array[PublicCertificate], required)
The certificates used by this certificate authority. The active certificate is the one that has been used to sign the current certificates of the Elasticsearch instances. All others are either certificates used in the past or certificates that will be used in the future when the currently active certificate expires.
recommended_trust_restriction (string, required)
The trust restriction expression to use that would provide trust with the Elasticsearch nodes of this deployment

Example

edit
{
   "public_certificates" : [
      {
         "active" : true,
         "metadata" : {
            "also_trusted_by" : [
               "string"
            ],
            "fingerprint" : "string",
            "valid_from" : "2019-01-01T00:00:00Z",
            "valid_to" : "2019-01-01T00:00:00Z"
         },
         "pem" : "string"
      }
   ],
   "recommended_trust_restriction" : "string"
}

CertificateMetaData

edit

The certificate MetaData

Properties

edit
also_trusted_by (array[string])
Other deployments also trusting this certificate
fingerprint (string, required)
The fingerprint of the certificate
valid_from (string as date-time, required)
The valid from date of the certificate in UTC
valid_to (string as date-time, required)
The expiry date of the certificate in UTC

Example

edit
{
   "also_trusted_by" : [
      "string"
   ],
   "fingerprint" : "string",
   "valid_from" : "2019-01-01T00:00:00Z",
   "valid_to" : "2019-01-01T00:00:00Z"
}

ChangeSourceInfo

edit

A container for information about the source of a change.

Properties

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

Example

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

ChartItem

edit

Chart Item

Properties

edit
timestamp (integer as int64, required)
Axis X position
values (array[ChartItemValue], required)
the collection of values to plot the chart item

Example

edit
{
   "timestamp" : 0,
   "values" : [
      {
         "id" : "string",
         "name" : "string",
         "value" : 0.1
      }
   ]
}

ChartItemValue

edit

A ChartItem value

Properties

edit
id (string, required)
The id of chart item value
name (string, required)
The name of the chart item value
value (number as double, required)
The actual value of the chart item value

Example

edit
{
   "id" : "string",
   "name" : "string",
   "value" : 0.1
}

ChartItems

edit

A collection of ChartItems

Properties

edit
data (array[ChartItem], required)
The list of chart item

Example

edit
{
   "data" : [
      {
         "timestamp" : 0,
         "values" : [
            {
               "id" : "string",
               "name" : "string",
               "value" : 0.1
            }
         ]
      }
   ]
}

ClusterCredentials

edit

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

Properties

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

Example

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

ClusterCurationSettings

edit

The index curation settings for an Elasticsearch cluster.

Properties

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

Example

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

ClusterCurationSpec

edit

Specifies the conditions to trigger an Elasticsearch cluster curation.

Properties

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

Example

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

ClusterInstanceConfigurationInfo

edit

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

Properties

edit
config_version (integer as int32)
If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.
id (string, required)
The id of the configuration used to create the instance
name (string, required)
The name of the configuration used to create the instance
resource (string; allowed values: [memory, storage], required)
The resource type of the instance configuration

Example

edit
{
   "config_version" : 0,
   "id" : "string",
   "name" : "string",
   "resource" : "string"
}

ClusterInstanceDiskInfo

edit

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

Properties

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

Example

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

ClusterInstanceInfo

edit

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

Properties

edit
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)
The name of the instance in Elastic Cloud
instance_overrides (InstanceOverrides)
Instance overrides
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 specific instances memory capacity and its usage
node_roles (array[string])
A list of the node roles assigned to the service running in the instance. Currently populated only for Elasticsearch.
service_roles (array[string])
List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml
service_running (boolean, required)
Whether the service launched inside the container -ie Elasticsearch- is actually running
service_version (string)
The version of the service that the instance is running (eg Elasticsearch or Kibana), if available
zone (string)
The zone in which this instance is being allocated

Example

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

ClusterInstanceMemoryInfo

edit

Information about the specific instances memory capacity and its usage

Properties

edit
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 Elasticsearch JVM heap space if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)
native_memory_pressure (integer as int32)
The % memory pressure of the instance Docker container (if available)

Example

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

ClusterMetadataInfo

edit

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

Properties

edit
aliased_endpoint (string)
The DNS name of the cluster endpoint derived from the deployment alias, if available
aliased_url (string)
The full aliased URL to access this deployment resource
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
services_urls (array[ServiceUrl])
A list of the URLs to access services that the resource provides at this time. Note that if the service is not running or has not started yet, the URL to access it won't be available
version (integer as int32, required)
The resource version number of the cluster metadata

Example

edit
{
   "aliased_endpoint" : "string",
   "aliased_url" : "string",
   "cloud_id" : "string",
   "endpoint" : "string",
   "last_modified" : "2019-01-01T00:00:00Z",
   "ports" : {
      "http" : 0,
      "https" : 0,
      "transport_passthrough" : 0
   },
   "raw" : {},
   "service_url" : "string",
   "services_urls" : [
      {
         "service" : "string",
         "url" : "string"
      }
   ],
   "version" : 0
}

ClusterMetadataPortInfo

edit

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

Properties

edit
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

Example

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

ClusterMetadataSettings

edit

The top-level configuration settings for the Elasticsearch cluster.

Properties

edit
name (string)
The display name of the cluster

Example

edit
{
   "name" : "string"
}

ClusterPlanAttemptError

edit

Information about an error during a plan attempt.

Properties

edit
details (map[string,string], required)
A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.
failure_type (string)
The failure type
message (string, required)
Human readable error message
timestamp (string as date-time, required)
Timestamp marking on info log of step

Example

edit
{
   "details" : {
      "some_property" : "string"
   },
   "failure_type" : "string",
   "message" : "string",
   "timestamp" : "2019-01-01T00:00:00Z"
}

ClusterPlanStepInfo

edit

Information about a step in a plan.

Properties

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

Example

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

ClusterPlanStepLogMessageInfo

edit

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

Properties

edit
delta_in_millis (integer as int64)
Time in milliseconds since previous log message
details (map[string,string], required)
A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.
failure_type (string)
The failure type, in case the step failed
message (string, required)
Human readable log message
stage (string; allowed values: [starting, completed, in_progress], required)
Stage that info log message takes place in
timestamp (string as date-time, required)
Timestamp marking on info log of step

Example

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

ClusterPlanWarning

edit

Information about a warning from a plan.

Properties

edit
code (string, required)
A unique warning code
message (string, required)
A description of the warning
step_id (string)
The ID of the step which produced a warning, if any

Example

edit
{
   "code" : "string",
   "message" : "string",
   "step_id" : "string"
}

ClusterSnapshotRetention

edit

Information about the Elasticsearch cluster snapshot retention.

Properties

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

Example

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

ClusterSnapshotSettings

edit

The snapshot configuration settings for an Elasticsearch cluster.

Properties

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

Example

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

ClusterSystemAlert

edit

Information about a system alert on an Elasticsearch cluster.

Properties

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

Example

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

ClusterTopologyInfo

edit

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

Properties

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

Example

edit
{
   "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" : {
            "config_version" : 0,
            "id" : "string",
            "name" : "string",
            "resource" : "string"
         },
         "instance_name" : "string",
         "instance_overrides" : {
            "capacity" : 0,
            "storage_multiplier" : 0.1
         },
         "maintenance_mode" : true,
         "memory" : {
            "instance_capacity" : 0,
            "instance_capacity_planned" : 0,
            "memory_pressure" : 0,
            "native_memory_pressure" : 0
         },
         "node_roles" : [
            "string"
         ],
         "service_roles" : [
            "string"
         ],
         "service_running" : true,
         "service_version" : "string",
         "zone" : "string"
      }
   ]
}

Costs

edit

Costs overview for an organization. All of the costs, credits, trials are expressed in Elastic Consumption Unit (ECU).

Properties

edit
dimensions (array[Dimension], required)
A collection of billing details by dimension.
total (number as double, required)
Total costs

Example

edit
{
   "dimensions" : [
      {
         "cost" : 0.1,
         "type" : "string"
      }
   ],
   "total" : 0.1
}

CostsOverview

edit

The top level costs overview for an organization. All of the costs, credits, trials are expressed in Elastic Consumption Unit (ECU).

Properties

edit
balance (Balance)
Balance for the organization
costs (Costs, required)
Costs for the organization
hourly_rate (number as double, required)
Hourly rate applied.
trials (number as double, required)
Trial costs for the organization

Example

edit
{
   "balance" : {
      "available" : 0.1,
      "line_items" : [
         {
            "ecu_balance" : 0.1,
            "ecu_quantity" : 0.1,
            "end" : "2019-01-01T00:00:00Z",
            "id" : "string",
            "start" : "2019-01-01T00:00:00Z"
         }
      ],
      "remaining" : 0.1
   },
   "costs" : {
      "dimensions" : [
         {
            "cost" : 0.1,
            "type" : "string"
         }
      ],
      "total" : 0.1
   },
   "hourly_rate" : 0.1,
   "trials" : 0.1
}

CreateApiKeyRequest

edit

The request payload that creates the API keys.

Properties

edit
description (string, required)
API key description. Useful if there are multiple keys
expiration (string)
The optional expiration for the API key, provided as a duration (ex: '1d', '3h')
role_assignments (RoleAssignments)
The optional roles for the API key. Takes the role of the creator if not specified. Currently unavailable in self-hosted ECE.

Example

edit
{
   "description" : "string",
   "expiration" : "string",
   "role_assignments" : {
      "deployment" : [
         {
            "all" : true,
            "application_roles" : [
               "string"
            ],
            "deployment_ids" : [
               "string"
            ],
            "organization_id" : "string",
            "role_id" : "string"
         }
      ],
      "organization" : [
         {
            "organization_id" : "string",
            "role_id" : "string"
         }
      ],
      "platform" : [
         {
            "role_id" : "string"
         }
      ],
      "project" : {
         "elasticsearch" : [
            {
               "all" : true,
               "application_roles" : [
                  "string"
               ],
               "organization_id" : "string",
               "project_ids" : [
                  "string"
               ],
               "role_id" : "string"
            }
         ],
         "observability" : [
            {
               "all" : true,
               "application_roles" : [
                  "string"
               ],
               "organization_id" : "string",
               "project_ids" : [
                  "string"
               ],
               "role_id" : "string"
            }
         ],
         "security" : [
            {
               "all" : true,
               "application_roles" : [
                  "string"
               ],
               "organization_id" : "string",
               "project_ids" : [
                  "string"
               ],
               "role_id" : "string"
            }
         ]
      }
   }
}

CreateExtensionRequest

edit

The body of a request to create a new extension

Properties

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

Example

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

Creates

edit

Holds diagnostics for resources that will be created

Properties

edit
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
integrations_server (array[IntegrationsServer])
Diagnostics for Integrations Server
kibana (array[Kibana])
Diagnostics for Kibanas

Example

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

DeleteApiKeysRequest

edit

The request payload that deletes the API keys.

Properties

edit
keys (array[string], required)
The list of API key IDs.

Example

edit
{
   "keys" : [
      "string"
   ]
}

DeploymentCosts

edit

Detailed costs for a deployment for an organization. All of the costs are expressed in Elastic Consumption Unit (ECU).

Properties

edit
costs (Costs, required)
Costs associated to the deployment
deployment_id (string, required)
Elasticsearch deployment id
deployment_name (string, required)
Elasticsearch deployment name
hourly_rate (number as double, required)
Price per hour
period (Period)
Period

Example

edit
{
   "costs" : {
      "dimensions" : [
         {
            "cost" : 0.1,
            "type" : "string"
         }
      ],
      "total" : 0.1
   },
   "deployment_id" : "string",
   "deployment_name" : "string",
   "hourly_rate" : 0.1,
   "period" : {
      "end" : "2019-01-01T00:00:00Z",
      "start" : "2019-01-01T00:00:00Z"
   }
}

DeploymentCreateMetadata

edit

Additional information about the new deployment object.

Properties

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

Example

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

DeploymentCreateRequest

edit

A request for creating a new Deployment consisting of multiple clusters

Properties

edit
alias (string)
A user-defined alias to use in place of Cluster IDs for user-friendly URLs
metadata (DeploymentCreateMetadata)
Additional information about this deployment
name (string)
A name for the deployment; otherwise this will be the generated deployment id
region (string)
Identifier of the region to be used as the default for all the resources of the deployment
resources (DeploymentCreateResources)
The Resources that will belong to this Deployment
settings (DeploymentCreateSettings)
Additional configuration for this Deployment
version (string)
The version for all the resources of the deployment (must be one of the supported versions). Defaults to the latest version if not specified.

Example

edit
{
   "alias" : "string",
   "metadata" : {
      "tags" : [
         {
            "key" : "string",
            "value" : "string"
         }
      ]
   },
   "name" : "string",
   "region" : "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",
                     "instance_configuration_version" : 0,
                     "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",
                     "instance_configuration_version" : 0,
                     "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" : {
               "autoscaling_enabled" : true,
               "cluster_topology" : [
                  {
                     "autoscaling_max" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "autoscaling_min" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "autoscaling_policy_override_json" : {},
                     "autoscaling_tier_override" : true,
                     "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
                              }
                           },
                           "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"
                     },
                     "id" : "string",
                     "instance_configuration_id" : "string",
                     "instance_configuration_version" : 0,
                     "node_roles" : [
                        "string"
                     ],
                     "node_type" : {
                        "data" : true,
                        "ingest" : true,
                        "master" : true,
                        "ml" : true
                     },
                     "size" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "topology_element_control" : {
                        "min" : {
                           "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
                        }
                     },
                     "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",
                           "info" : {
                              "compatible" : true,
                              "connected" : true,
                              "healthy" : true,
                              "trusted" : true,
                              "trusted_back" : true
                           },
                           "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" : {
               "curation" : {
                  "specs" : [
                     {
                        "index_pattern" : "string",
                        "trigger_interval_seconds" : 0
                     }
                  ]
               },
               "dedicated_masters_threshold" : 0,
               "keystore_contents" : {
                  "secrets" : {
                     "some_property" : {
                        "as_file" : true,
                        "value" : {}
                     }
                  }
               },
               "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",
                        "name" : "string",
                        "trust_all" : true,
                        "trust_allowlist" : [
                           "string"
                        ]
                     }
                  ],
                  "direct" : [
                     {
                        "additional_node_names" : [
                           "string"
                        ],
                        "certificates" : [
                           {
                              "metadata" : {
                                 "also_trusted_by" : [
                                    "string"
                                 ],
                                 "fingerprint" : "string",
                                 "valid_from" : "2019-01-01T00:00:00Z",
                                 "valid_to" : "2019-01-01T00:00:00Z"
                              },
                              "pem" : "string"
                           }
                        ],
                        "name" : "string",
                        "scope_id" : "string",
                        "trust_all" : true,
                        "trust_allowlist" : [
                           "string"
                        ],
                        "type" : "string",
                        "uid" : "string"
                     }
                  ],
                  "external" : [
                     {
                        "name" : "string",
                        "trust_all" : true,
                        "trust_allowlist" : [
                           "string"
                        ],
                        "trust_relationship_id" : "string"
                     }
                  ]
               }
            }
         }
      ],
      "enterprise_search" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "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",
                     "instance_configuration_version" : 0,
                     "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" : {}
                  }
               }
            },
            "ref_id" : "string",
            "region" : "string",
            "settings" : {
               "metadata" : {
                  "name" : "string"
               }
            }
         }
      ],
      "integrations_server" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "plan" : {
               "cluster_topology" : [
                  {
                     "instance_configuration_id" : "string",
                     "instance_configuration_version" : 0,
                     "integrations_server" : {
                        "docker_image" : "string",
                        "mode" : "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"
                     },
                     "size" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "zone_count" : 0
                  }
               ],
               "integrations_server" : {
                  "docker_image" : "string",
                  "mode" : "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"
               },
               "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"
               }
            }
         }
      ],
      "kibana" : [
         {
            "display_name" : "string",
            "elasticsearch_cluster_ref_id" : "string",
            "plan" : {
               "cluster_topology" : [
                  {
                     "instance_configuration_id" : "string",
                     "instance_configuration_version" : 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"
                     },
                     "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" : {
      "autoscaling_enabled" : true,
      "observability" : {
         "logging" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         },
         "metrics" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         }
      },
      "traffic_filter_settings" : {
         "rulesets" : [
            "string"
         ]
      }
   },
   "version" : "string"
}

DeploymentCreateResources

edit

Describes the resources that will belong to a Deployment

Properties

edit
apm (array[ApmPayload])
A list of payloads for APM creation. WARNING: For stack versions 8.0.0 and higher the integrations_server payload should be used instead, as this field becomes deprecated.
appsearch (array[AppSearchPayload])
A list of payloads for AppSearch updates. AppSearch has been replaced by Enterprise Search in the Elastic Stack 7.7 and higher.
elasticsearch (array[ElasticsearchPayload])
A list of payloads for Elasticsearch cluster creation.
enterprise_search (array[EnterpriseSearchPayload])
A list of payloads for Enterprise Search creation.
integrations_server (array[IntegrationsServerPayload])
A list of payloads for Integrations Server creation.
kibana (array[KibanaPayload])
A list of payloads for Kibana creation.

Example

edit
{
   "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",
                  "instance_configuration_version" : 0,
                  "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",
                  "instance_configuration_version" : 0,
                  "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" : {
            "autoscaling_enabled" : true,
            "cluster_topology" : [
               {
                  "autoscaling_max" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "autoscaling_min" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "autoscaling_policy_override_json" : {},
                  "autoscaling_tier_override" : true,
                  "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
                           }
                        },
                        "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"
                  },
                  "id" : "string",
                  "instance_configuration_id" : "string",
                  "instance_configuration_version" : 0,
                  "node_roles" : [
                     "string"
                  ],
                  "node_type" : {
                     "data" : true,
                     "ingest" : true,
                     "master" : true,
                     "ml" : true
                  },
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "topology_element_control" : {
                     "min" : {
                        "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
                     }
                  },
                  "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",
                        "info" : {
                           "compatible" : true,
                           "connected" : true,
                           "healthy" : true,
                           "trusted" : true,
                           "trusted_back" : true
                        },
                        "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" : {
            "curation" : {
               "specs" : [
                  {
                     "index_pattern" : "string",
                     "trigger_interval_seconds" : 0
                  }
               ]
            },
            "dedicated_masters_threshold" : 0,
            "keystore_contents" : {
               "secrets" : {
                  "some_property" : {
                     "as_file" : true,
                     "value" : {}
                  }
               }
            },
            "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",
                     "name" : "string",
                     "trust_all" : true,
                     "trust_allowlist" : [
                        "string"
                     ]
                  }
               ],
               "direct" : [
                  {
                     "additional_node_names" : [
                        "string"
                     ],
                     "certificates" : [
                        {
                           "metadata" : {
                              "also_trusted_by" : [
                                 "string"
                              ],
                              "fingerprint" : "string",
                              "valid_from" : "2019-01-01T00:00:00Z",
                              "valid_to" : "2019-01-01T00:00:00Z"
                           },
                           "pem" : "string"
                        }
                     ],
                     "name" : "string",
                     "scope_id" : "string",
                     "trust_all" : true,
                     "trust_allowlist" : [
                        "string"
                     ],
                     "type" : "string",
                     "uid" : "string"
                  }
               ],
               "external" : [
                  {
                     "name" : "string",
                     "trust_all" : true,
                     "trust_allowlist" : [
                        "string"
                     ],
                     "trust_relationship_id" : "string"
                  }
               ]
            }
         }
      }
   ],
   "enterprise_search" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "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",
                  "instance_configuration_version" : 0,
                  "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" : {}
               }
            }
         },
         "ref_id" : "string",
         "region" : "string",
         "settings" : {
            "metadata" : {
               "name" : "string"
            }
         }
      }
   ],
   "integrations_server" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "plan" : {
            "cluster_topology" : [
               {
                  "instance_configuration_id" : "string",
                  "instance_configuration_version" : 0,
                  "integrations_server" : {
                     "docker_image" : "string",
                     "mode" : "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"
                  },
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "integrations_server" : {
               "docker_image" : "string",
               "mode" : "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"
            },
            "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"
            }
         }
      }
   ],
   "kibana" : [
      {
         "display_name" : "string",
         "elasticsearch_cluster_ref_id" : "string",
         "plan" : {
            "cluster_topology" : [
               {
                  "instance_configuration_id" : "string",
                  "instance_configuration_version" : 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"
                  },
                  "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"
            }
         }
      }
   ]
}

DeploymentCreateResponse

edit

A response returned from the Deployment create endpoint

Properties

edit
alias (string)
A user-defined deployment alias for user-friendly resource URLs
created (boolean, required)
Whether or not the deployment was freshly created
diagnostics (DeploymentDiagnostics)
Backend diagnostics. Sent if validation is requested.
id (string, required)
The id of the deployment
name (string, required)
The name of the deployment
resources (array[DeploymentResource], required)
List of created resources.

Example

edit
{
   "alias" : "string",
   "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"
            }
         ],
         "integrations_server" : [
            {
               "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"
            }
         ],
         "integrations_server" : [
            {
               "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"
            }
         ]
      }
   ]
}

DeploymentCreateSettings

edit

Additional configuration for the new deployment object.

Properties

edit
autoscaling_enabled (boolean)
Enable autoscaling for this deployment.
observability (DeploymentObservabilitySettings)
Observability settings for this deployment
traffic_filter_settings (TrafficFilterSettings)
The traffic filter rulesets to apply to this deployment.

Example

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

DeploymentDiagnostics

edit

Describes the diagnostics for a given Deployment-modifying payload

Properties

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

Example

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

DeploymentGetResponse

edit

Describes a given Deployment

Properties

edit
alias (string)
A user-defined deployment alias for user-friendly resource URLs
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
instance_configurations (array[InstanceConfigurationInfo])
List of instance configurations used in the 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

Example

edit
{
   "alias" : "string",
   "healthy" : true,
   "id" : "string",
   "instance_configurations" : [
      {
         "config_version" : 0,
         "cpu_multiplier" : 0.1,
         "description" : "string",
         "discrete_sizes" : {
            "default_size" : 0,
            "resource" : "string",
            "sizes" : [
               0
            ]
         },
         "id" : "string",
         "instance_type" : "string",
         "max_zones" : 0,
         "metadata" : {},
         "name" : "string",
         "node_types" : [
            "string"
         ],
         "storage_multiplier" : 0.1
      }
   ],
   "metadata" : {
      "byok_enabled" : true,
      "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" : {
               "apm_server_mode" : "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,
               "id" : "string",
               "links" : {
                  "some_property" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "aliased_endpoint" : "string",
                  "aliased_url" : "string",
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "services_urls" : [
                     {
                        "service" : "string",
                        "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",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  },
                  "healthy" : true,
                  "history" : [
                     {
                        "attempt_end_time" : "2019-01-01T00:00:00Z",
                        "attempt_start_time" : "2019-01-01T00:00:00Z",
                        "error" : {
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "message" : "string",
                           "timestamp" : "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",
                                 "instance_configuration_version" : 0,
                                 "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,
                                    "details" : {
                                       "some_property" : "string"
                                    },
                                    "failure_type" : "string",
                                    "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"
                        },
                        "warnings" : [
                           {
                              "code" : "string",
                              "message" : "string",
                              "step_id" : "string"
                           }
                        ]
                     }
                  ],
                  "pending" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_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" : {
                           "config_version" : 0,
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "instance_overrides" : {
                           "capacity" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "node_roles" : [
                           "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" : {
                  "aliased_endpoint" : "string",
                  "aliased_url" : "string",
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "services_urls" : [
                     {
                        "service" : "string",
                        "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",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  },
                  "healthy" : true,
                  "history" : [
                     {
                        "attempt_end_time" : "2019-01-01T00:00:00Z",
                        "attempt_start_time" : "2019-01-01T00:00:00Z",
                        "error" : {
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "message" : "string",
                           "timestamp" : "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",
                                 "instance_configuration_version" : 0,
                                 "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,
                                    "details" : {
                                       "some_property" : "string"
                                    },
                                    "failure_type" : "string",
                                    "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"
                        },
                        "warnings" : [
                           {
                              "code" : "string",
                              "message" : "string",
                              "step_id" : "string"
                           }
                        ]
                     }
                  ],
                  "pending" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_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" : {
                           "config_version" : 0,
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "instance_overrides" : {
                           "capacity" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "node_roles" : [
                           "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
                        }
                     }
                  }
               ],
               "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"
                           ]
                        }
                     ]
                  },
                  "cluster_blocking_issues" : {
                     "blocks" : [
                        {
                           "description" : "string",
                           "level" : "string"
                        }
                     ],
                     "healthy" : true
                  },
                  "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
                        }
                     ]
                  },
                  "shards_status" : {
                     "status" : "string"
                  }
               },
               "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" : {
                  "aliased_endpoint" : "string",
                  "aliased_url" : "string",
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "services_urls" : [
                     {
                        "service" : "string",
                        "url" : "string"
                     }
                  ],
                  "version" : 0
               },
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "autoscaling_enabled" : true,
                        "cluster_topology" : [
                           {
                              "autoscaling_max" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "autoscaling_min" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "autoscaling_policy_override_json" : {},
                              "autoscaling_tier_override" : true,
                              "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
                                       }
                                    },
                                    "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"
                              },
                              "id" : "string",
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 0,
                              "node_roles" : [
                                 "string"
                              ],
                              "node_type" : {
                                 "data" : true,
                                 "ingest" : true,
                                 "master" : true,
                                 "ml" : true
                              },
                              "size" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "topology_element_control" : {
                                 "min" : {
                                    "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
                                 }
                              },
                              "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",
                                    "info" : {
                                       "compatible" : true,
                                       "connected" : true,
                                       "healthy" : true,
                                       "trusted" : true,
                                       "trusted_back" : true
                                    },
                                    "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  },
                  "healthy" : true,
                  "history" : [
                     {
                        "attempt_end_time" : "2019-01-01T00:00:00Z",
                        "attempt_start_time" : "2019-01-01T00:00:00Z",
                        "error" : {
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "message" : "string",
                           "timestamp" : "2019-01-01T00:00:00Z"
                        },
                        "healthy" : true,
                        "plan" : {
                           "autoscaling_enabled" : true,
                           "cluster_topology" : [
                              {
                                 "autoscaling_max" : {
                                    "resource" : "string",
                                    "value" : 0
                                 },
                                 "autoscaling_min" : {
                                    "resource" : "string",
                                    "value" : 0
                                 },
                                 "autoscaling_policy_override_json" : {},
                                 "autoscaling_tier_override" : true,
                                 "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
                                          }
                                       },
                                       "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"
                                 },
                                 "id" : "string",
                                 "instance_configuration_id" : "string",
                                 "instance_configuration_version" : 0,
                                 "node_roles" : [
                                    "string"
                                 ],
                                 "node_type" : {
                                    "data" : true,
                                    "ingest" : true,
                                    "master" : true,
                                    "ml" : true
                                 },
                                 "size" : {
                                    "resource" : "string",
                                    "value" : 0
                                 },
                                 "topology_element_control" : {
                                    "min" : {
                                       "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
                                    }
                                 },
                                 "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",
                                       "info" : {
                                          "compatible" : true,
                                          "connected" : true,
                                          "healthy" : true,
                                          "trusted" : true,
                                          "trusted_back" : true
                                       },
                                       "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,
                                    "details" : {
                                       "some_property" : "string"
                                    },
                                    "failure_type" : "string",
                                    "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"
                        },
                        "warnings" : [
                           {
                              "code" : "string",
                              "message" : "string",
                              "step_id" : "string"
                           }
                        ]
                     }
                  ],
                  "pending" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "autoscaling_enabled" : true,
                        "cluster_topology" : [
                           {
                              "autoscaling_max" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "autoscaling_min" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "autoscaling_policy_override_json" : {},
                              "autoscaling_tier_override" : true,
                              "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
                                       }
                                    },
                                    "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"
                              },
                              "id" : "string",
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 0,
                              "node_roles" : [
                                 "string"
                              ],
                              "node_type" : {
                                 "data" : true,
                                 "ingest" : true,
                                 "master" : true,
                                 "ml" : true
                              },
                              "size" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "topology_element_control" : {
                                 "min" : {
                                    "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
                                 }
                              },
                              "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",
                                    "info" : {
                                       "compatible" : true,
                                       "connected" : true,
                                       "healthy" : true,
                                       "trusted" : true,
                                       "trusted_back" : true
                                    },
                                    "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_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" : {
                  "curation" : {
                     "specs" : [
                        {
                           "index_pattern" : "string",
                           "trigger_interval_seconds" : 0
                        }
                     ]
                  },
                  "dedicated_masters_threshold" : 0,
                  "keystore_contents" : {
                     "secrets" : {
                        "some_property" : {
                           "as_file" : true,
                           "value" : {}
                        }
                     }
                  },
                  "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",
                           "name" : "string",
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ]
                        }
                     ],
                     "direct" : [
                        {
                           "additional_node_names" : [
                              "string"
                           ],
                           "certificates" : [
                              {
                                 "metadata" : {
                                    "also_trusted_by" : [
                                       "string"
                                    ],
                                    "fingerprint" : "string",
                                    "valid_from" : "2019-01-01T00:00:00Z",
                                    "valid_to" : "2019-01-01T00:00:00Z"
                                 },
                                 "pem" : "string"
                              }
                           ],
                           "name" : "string",
                           "scope_id" : "string",
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ],
                           "type" : "string",
                           "uid" : "string"
                        }
                     ],
                     "external" : [
                        {
                           "name" : "string",
                           "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" : {
                           "config_version" : 0,
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "instance_overrides" : {
                           "capacity" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "node_roles" : [
                           "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" : {
                  "aliased_endpoint" : "string",
                  "aliased_url" : "string",
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "services_urls" : [
                     {
                        "service" : "string",
                        "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",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  },
                  "healthy" : true,
                  "history" : [
                     {
                        "attempt_end_time" : "2019-01-01T00:00:00Z",
                        "attempt_start_time" : "2019-01-01T00:00:00Z",
                        "error" : {
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "message" : "string",
                           "timestamp" : "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",
                                 "instance_configuration_version" : 0,
                                 "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,
                                    "details" : {
                                       "some_property" : "string"
                                    },
                                    "failure_type" : "string",
                                    "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"
                        },
                        "warnings" : [
                           {
                              "code" : "string",
                              "message" : "string",
                              "step_id" : "string"
                           }
                        ]
                     }
                  ],
                  "pending" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_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" : {
                           "config_version" : 0,
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "instance_overrides" : {
                           "capacity" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "node_roles" : [
                           "string"
                        ],
                        "service_roles" : [
                           "string"
                        ],
                        "service_running" : true,
                        "service_version" : "string",
                        "zone" : "string"
                     }
                  ]
               }
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ],
      "integrations_server" : [
         {
            "elasticsearch_cluster_ref_id" : "string",
            "id" : "string",
            "info" : {
               "apm_server_mode" : "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,
               "id" : "string",
               "links" : {
                  "some_property" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "aliased_endpoint" : "string",
                  "aliased_url" : "string",
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "services_urls" : [
                     {
                        "service" : "string",
                        "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",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 0,
                              "integrations_server" : {
                                 "docker_image" : "string",
                                 "mode" : "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"
                              },
                              "size" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "zone_count" : 0
                           }
                        ],
                        "integrations_server" : {
                           "docker_image" : "string",
                           "mode" : "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"
                        },
                        "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  },
                  "healthy" : true,
                  "history" : [
                     {
                        "attempt_end_time" : "2019-01-01T00:00:00Z",
                        "attempt_start_time" : "2019-01-01T00:00:00Z",
                        "error" : {
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "message" : "string",
                           "timestamp" : "2019-01-01T00:00:00Z"
                        },
                        "healthy" : true,
                        "plan" : {
                           "cluster_topology" : [
                              {
                                 "instance_configuration_id" : "string",
                                 "instance_configuration_version" : 0,
                                 "integrations_server" : {
                                    "docker_image" : "string",
                                    "mode" : "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"
                                 },
                                 "size" : {
                                    "resource" : "string",
                                    "value" : 0
                                 },
                                 "zone_count" : 0
                              }
                           ],
                           "integrations_server" : {
                              "docker_image" : "string",
                              "mode" : "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"
                           },
                           "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,
                                    "details" : {
                                       "some_property" : "string"
                                    },
                                    "failure_type" : "string",
                                    "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"
                        },
                        "warnings" : [
                           {
                              "code" : "string",
                              "message" : "string",
                              "step_id" : "string"
                           }
                        ]
                     }
                  ],
                  "pending" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 0,
                              "integrations_server" : {
                                 "docker_image" : "string",
                                 "mode" : "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"
                              },
                              "size" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "zone_count" : 0
                           }
                        ],
                        "integrations_server" : {
                           "docker_image" : "string",
                           "mode" : "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"
                        },
                        "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_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" : {
                           "config_version" : 0,
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "instance_overrides" : {
                           "capacity" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "node_roles" : [
                           "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" : {
                  "aliased_endpoint" : "string",
                  "aliased_url" : "string",
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "services_urls" : [
                     {
                        "service" : "string",
                        "url" : "string"
                     }
                  ],
                  "version" : 0
               },
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 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"
                              },
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  },
                  "healthy" : true,
                  "history" : [
                     {
                        "attempt_end_time" : "2019-01-01T00:00:00Z",
                        "attempt_start_time" : "2019-01-01T00:00:00Z",
                        "error" : {
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "message" : "string",
                           "timestamp" : "2019-01-01T00:00:00Z"
                        },
                        "healthy" : true,
                        "plan" : {
                           "cluster_topology" : [
                              {
                                 "instance_configuration_id" : "string",
                                 "instance_configuration_version" : 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"
                                 },
                                 "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,
                                    "details" : {
                                       "some_property" : "string"
                                    },
                                    "failure_type" : "string",
                                    "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"
                        },
                        "warnings" : [
                           {
                              "code" : "string",
                              "message" : "string",
                              "step_id" : "string"
                           }
                        ]
                     }
                  ],
                  "pending" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 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"
                              },
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_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" : {
                           "config_version" : 0,
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "instance_overrides" : {
                           "capacity" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "node_roles" : [
                           "string"
                        ],
                        "service_roles" : [
                           "string"
                        ],
                        "service_running" : true,
                        "service_version" : "string",
                        "zone" : "string"
                     }
                  ]
               }
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ]
   },
   "settings" : {
      "auto_ops" : {
         "status" : "string"
      },
      "autoscaling_enabled" : true,
      "observability" : {
         "logging" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         },
         "metrics" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         }
      },
      "traffic_filter_settings" : {
         "rulesets" : [
            "string"
         ]
      }
   }
}

DeploymentLogging

edit

Logging information for a deployment

Properties

edit
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

Example

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

DeploymentLoggingSettings

edit

The logging settings for a deployment

Properties

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

Example

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

DeploymentMetadata

edit

Additional information about the current deployment object.

Properties

edit
byok_enabled (boolean)
Indicates if the Deployment is BYOK enabled or not
tags (array[MetadataItem])
Arbitrary user-defined metadata associated with this deployment

Example

edit
{
   "byok_enabled" : true,
   "tags" : [
      {
         "key" : "string",
         "value" : "string"
      }
   ]
}

DeploymentMetrics

edit

Metrics information for a deployment

Properties

edit
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

Example

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

DeploymentMetricsSettings

edit

The metrics settings for a deployment

Properties

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

Example

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

DeploymentObservability

edit

Observability information for a deployment

Properties

edit
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

Example

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

DeploymentObservabilitySettings

edit

The observability settings for a deployment

Properties

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

Example

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

DeploymentResource

edit

Data for a deployment resource

Properties

edit
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

Example

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

DeploymentResourceCommandResponse

edit

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

Properties

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

Example

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

DeploymentResourceCrudResponse

edit

A response returned from the Deployment Resource endpoints

Properties

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

Example

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

DeploymentResourceUpgradeResponse

edit

Intentionally left blank

Properties

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

Example

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

DeploymentResources

edit

Describes a resource belonging to a Deployment

Properties

edit
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
integrations_server (array[IntegrationsServerResourceInfo], required)
List of Integrations Server resources in your Deployment
kibana (array[KibanaResourceInfo], required)
List of Kibana resources in your Deployment

Example

edit
{
   "apm" : [
      {
         "elasticsearch_cluster_ref_id" : "string",
         "id" : "string",
         "info" : {
            "apm_server_mode" : "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,
            "id" : "string",
            "links" : {
               "some_property" : {
                  "need_elevated_permissions" : true
               }
            },
            "metadata" : {
               "aliased_endpoint" : "string",
               "aliased_url" : "string",
               "cloud_id" : "string",
               "endpoint" : "string",
               "last_modified" : "2019-01-01T00:00:00Z",
               "ports" : {
                  "http" : 0,
                  "https" : 0,
                  "transport_passthrough" : 0
               },
               "raw" : {},
               "service_url" : "string",
               "services_urls" : [
                  {
                     "service" : "string",
                     "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",
                  "error" : {
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "message" : "string",
                     "timestamp" : "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",
                           "instance_configuration_version" : 0,
                           "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,
                              "details" : {
                                 "some_property" : "string"
                              },
                              "failure_type" : "string",
                              "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"
                  },
                  "warnings" : [
                     {
                        "code" : "string",
                        "message" : "string",
                        "step_id" : "string"
                     }
                  ]
               },
               "healthy" : true,
               "history" : [
                  {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  }
               ],
               "pending" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "error" : {
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "message" : "string",
                     "timestamp" : "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",
                           "instance_configuration_version" : 0,
                           "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,
                              "details" : {
                                 "some_property" : "string"
                              },
                              "failure_type" : "string",
                              "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"
                  },
                  "warnings" : [
                     {
                        "code" : "string",
                        "message" : "string",
                        "step_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" : {
                        "config_version" : 0,
                        "id" : "string",
                        "name" : "string",
                        "resource" : "string"
                     },
                     "instance_name" : "string",
                     "instance_overrides" : {
                        "capacity" : 0,
                        "storage_multiplier" : 0.1
                     },
                     "maintenance_mode" : true,
                     "memory" : {
                        "instance_capacity" : 0,
                        "instance_capacity_planned" : 0,
                        "memory_pressure" : 0,
                        "native_memory_pressure" : 0
                     },
                     "node_roles" : [
                        "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" : {
               "aliased_endpoint" : "string",
               "aliased_url" : "string",
               "cloud_id" : "string",
               "endpoint" : "string",
               "last_modified" : "2019-01-01T00:00:00Z",
               "ports" : {
                  "http" : 0,
                  "https" : 0,
                  "transport_passthrough" : 0
               },
               "raw" : {},
               "service_url" : "string",
               "services_urls" : [
                  {
                     "service" : "string",
                     "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",
                  "error" : {
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "message" : "string",
                     "timestamp" : "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",
                           "instance_configuration_version" : 0,
                           "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,
                              "details" : {
                                 "some_property" : "string"
                              },
                              "failure_type" : "string",
                              "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"
                  },
                  "warnings" : [
                     {
                        "code" : "string",
                        "message" : "string",
                        "step_id" : "string"
                     }
                  ]
               },
               "healthy" : true,
               "history" : [
                  {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  }
               ],
               "pending" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "error" : {
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "message" : "string",
                     "timestamp" : "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",
                           "instance_configuration_version" : 0,
                           "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,
                              "details" : {
                                 "some_property" : "string"
                              },
                              "failure_type" : "string",
                              "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"
                  },
                  "warnings" : [
                     {
                        "code" : "string",
                        "message" : "string",
                        "step_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" : {
                        "config_version" : 0,
                        "id" : "string",
                        "name" : "string",
                        "resource" : "string"
                     },
                     "instance_name" : "string",
                     "instance_overrides" : {
                        "capacity" : 0,
                        "storage_multiplier" : 0.1
                     },
                     "maintenance_mode" : true,
                     "memory" : {
                        "instance_capacity" : 0,
                        "instance_capacity_planned" : 0,
                        "memory_pressure" : 0,
                        "native_memory_pressure" : 0
                     },
                     "node_roles" : [
                        "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
                     }
                  }
               }
            ],
            "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"
                        ]
                     }
                  ]
               },
               "cluster_blocking_issues" : {
                  "blocks" : [
                     {
                        "description" : "string",
                        "level" : "string"
                     }
                  ],
                  "healthy" : true
               },
               "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
                     }
                  ]
               },
               "shards_status" : {
                  "status" : "string"
               }
            },
            "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" : {
               "aliased_endpoint" : "string",
               "aliased_url" : "string",
               "cloud_id" : "string",
               "endpoint" : "string",
               "last_modified" : "2019-01-01T00:00:00Z",
               "ports" : {
                  "http" : 0,
                  "https" : 0,
                  "transport_passthrough" : 0
               },
               "raw" : {},
               "service_url" : "string",
               "services_urls" : [
                  {
                     "service" : "string",
                     "url" : "string"
                  }
               ],
               "version" : 0
            },
            "plan_info" : {
               "current" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "error" : {
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "message" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z"
                  },
                  "healthy" : true,
                  "plan" : {
                     "autoscaling_enabled" : true,
                     "cluster_topology" : [
                        {
                           "autoscaling_max" : {
                              "resource" : "string",
                              "value" : 0
                           },
                           "autoscaling_min" : {
                              "resource" : "string",
                              "value" : 0
                           },
                           "autoscaling_policy_override_json" : {},
                           "autoscaling_tier_override" : true,
                           "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
                                    }
                                 },
                                 "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"
                           },
                           "id" : "string",
                           "instance_configuration_id" : "string",
                           "instance_configuration_version" : 0,
                           "node_roles" : [
                              "string"
                           ],
                           "node_type" : {
                              "data" : true,
                              "ingest" : true,
                              "master" : true,
                              "ml" : true
                           },
                           "size" : {
                              "resource" : "string",
                              "value" : 0
                           },
                           "topology_element_control" : {
                              "min" : {
                                 "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
                              }
                           },
                           "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",
                                 "info" : {
                                    "compatible" : true,
                                    "connected" : true,
                                    "healthy" : true,
                                    "trusted" : true,
                                    "trusted_back" : true
                                 },
                                 "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,
                              "details" : {
                                 "some_property" : "string"
                              },
                              "failure_type" : "string",
                              "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"
                  },
                  "warnings" : [
                     {
                        "code" : "string",
                        "message" : "string",
                        "step_id" : "string"
                     }
                  ]
               },
               "healthy" : true,
               "history" : [
                  {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "autoscaling_enabled" : true,
                        "cluster_topology" : [
                           {
                              "autoscaling_max" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "autoscaling_min" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "autoscaling_policy_override_json" : {},
                              "autoscaling_tier_override" : true,
                              "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
                                       }
                                    },
                                    "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"
                              },
                              "id" : "string",
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 0,
                              "node_roles" : [
                                 "string"
                              ],
                              "node_type" : {
                                 "data" : true,
                                 "ingest" : true,
                                 "master" : true,
                                 "ml" : true
                              },
                              "size" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "topology_element_control" : {
                                 "min" : {
                                    "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
                                 }
                              },
                              "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",
                                    "info" : {
                                       "compatible" : true,
                                       "connected" : true,
                                       "healthy" : true,
                                       "trusted" : true,
                                       "trusted_back" : true
                                    },
                                    "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  }
               ],
               "pending" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "error" : {
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "message" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z"
                  },
                  "healthy" : true,
                  "plan" : {
                     "autoscaling_enabled" : true,
                     "cluster_topology" : [
                        {
                           "autoscaling_max" : {
                              "resource" : "string",
                              "value" : 0
                           },
                           "autoscaling_min" : {
                              "resource" : "string",
                              "value" : 0
                           },
                           "autoscaling_policy_override_json" : {},
                           "autoscaling_tier_override" : true,
                           "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
                                    }
                                 },
                                 "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"
                           },
                           "id" : "string",
                           "instance_configuration_id" : "string",
                           "instance_configuration_version" : 0,
                           "node_roles" : [
                              "string"
                           ],
                           "node_type" : {
                              "data" : true,
                              "ingest" : true,
                              "master" : true,
                              "ml" : true
                           },
                           "size" : {
                              "resource" : "string",
                              "value" : 0
                           },
                           "topology_element_control" : {
                              "min" : {
                                 "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
                              }
                           },
                           "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",
                                 "info" : {
                                    "compatible" : true,
                                    "connected" : true,
                                    "healthy" : true,
                                    "trusted" : true,
                                    "trusted_back" : true
                                 },
                                 "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,
                              "details" : {
                                 "some_property" : "string"
                              },
                              "failure_type" : "string",
                              "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"
                  },
                  "warnings" : [
                     {
                        "code" : "string",
                        "message" : "string",
                        "step_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" : {
               "curation" : {
                  "specs" : [
                     {
                        "index_pattern" : "string",
                        "trigger_interval_seconds" : 0
                     }
                  ]
               },
               "dedicated_masters_threshold" : 0,
               "keystore_contents" : {
                  "secrets" : {
                     "some_property" : {
                        "as_file" : true,
                        "value" : {}
                     }
                  }
               },
               "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",
                        "name" : "string",
                        "trust_all" : true,
                        "trust_allowlist" : [
                           "string"
                        ]
                     }
                  ],
                  "direct" : [
                     {
                        "additional_node_names" : [
                           "string"
                        ],
                        "certificates" : [
                           {
                              "metadata" : {
                                 "also_trusted_by" : [
                                    "string"
                                 ],
                                 "fingerprint" : "string",
                                 "valid_from" : "2019-01-01T00:00:00Z",
                                 "valid_to" : "2019-01-01T00:00:00Z"
                              },
                              "pem" : "string"
                           }
                        ],
                        "name" : "string",
                        "scope_id" : "string",
                        "trust_all" : true,
                        "trust_allowlist" : [
                           "string"
                        ],
                        "type" : "string",
                        "uid" : "string"
                     }
                  ],
                  "external" : [
                     {
                        "name" : "string",
                        "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" : {
                        "config_version" : 0,
                        "id" : "string",
                        "name" : "string",
                        "resource" : "string"
                     },
                     "instance_name" : "string",
                     "instance_overrides" : {
                        "capacity" : 0,
                        "storage_multiplier" : 0.1
                     },
                     "maintenance_mode" : true,
                     "memory" : {
                        "instance_capacity" : 0,
                        "instance_capacity_planned" : 0,
                        "memory_pressure" : 0,
                        "native_memory_pressure" : 0
                     },
                     "node_roles" : [
                        "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" : {
               "aliased_endpoint" : "string",
               "aliased_url" : "string",
               "cloud_id" : "string",
               "endpoint" : "string",
               "last_modified" : "2019-01-01T00:00:00Z",
               "ports" : {
                  "http" : 0,
                  "https" : 0,
                  "transport_passthrough" : 0
               },
               "raw" : {},
               "service_url" : "string",
               "services_urls" : [
                  {
                     "service" : "string",
                     "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",
                  "error" : {
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "message" : "string",
                     "timestamp" : "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",
                           "instance_configuration_version" : 0,
                           "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,
                              "details" : {
                                 "some_property" : "string"
                              },
                              "failure_type" : "string",
                              "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"
                  },
                  "warnings" : [
                     {
                        "code" : "string",
                        "message" : "string",
                        "step_id" : "string"
                     }
                  ]
               },
               "healthy" : true,
               "history" : [
                  {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  }
               ],
               "pending" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "error" : {
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "message" : "string",
                     "timestamp" : "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",
                           "instance_configuration_version" : 0,
                           "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,
                              "details" : {
                                 "some_property" : "string"
                              },
                              "failure_type" : "string",
                              "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"
                  },
                  "warnings" : [
                     {
                        "code" : "string",
                        "message" : "string",
                        "step_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" : {
                        "config_version" : 0,
                        "id" : "string",
                        "name" : "string",
                        "resource" : "string"
                     },
                     "instance_name" : "string",
                     "instance_overrides" : {
                        "capacity" : 0,
                        "storage_multiplier" : 0.1
                     },
                     "maintenance_mode" : true,
                     "memory" : {
                        "instance_capacity" : 0,
                        "instance_capacity_planned" : 0,
                        "memory_pressure" : 0,
                        "native_memory_pressure" : 0
                     },
                     "node_roles" : [
                        "string"
                     ],
                     "service_roles" : [
                        "string"
                     ],
                     "service_running" : true,
                     "service_version" : "string",
                     "zone" : "string"
                  }
               ]
            }
         },
         "ref_id" : "string",
         "region" : "string"
      }
   ],
   "integrations_server" : [
      {
         "elasticsearch_cluster_ref_id" : "string",
         "id" : "string",
         "info" : {
            "apm_server_mode" : "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,
            "id" : "string",
            "links" : {
               "some_property" : {
                  "need_elevated_permissions" : true
               }
            },
            "metadata" : {
               "aliased_endpoint" : "string",
               "aliased_url" : "string",
               "cloud_id" : "string",
               "endpoint" : "string",
               "last_modified" : "2019-01-01T00:00:00Z",
               "ports" : {
                  "http" : 0,
                  "https" : 0,
                  "transport_passthrough" : 0
               },
               "raw" : {},
               "service_url" : "string",
               "services_urls" : [
                  {
                     "service" : "string",
                     "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",
                  "error" : {
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "message" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z"
                  },
                  "healthy" : true,
                  "plan" : {
                     "cluster_topology" : [
                        {
                           "instance_configuration_id" : "string",
                           "instance_configuration_version" : 0,
                           "integrations_server" : {
                              "docker_image" : "string",
                              "mode" : "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"
                           },
                           "size" : {
                              "resource" : "string",
                              "value" : 0
                           },
                           "zone_count" : 0
                        }
                     ],
                     "integrations_server" : {
                        "docker_image" : "string",
                        "mode" : "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"
                     },
                     "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,
                              "details" : {
                                 "some_property" : "string"
                              },
                              "failure_type" : "string",
                              "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"
                  },
                  "warnings" : [
                     {
                        "code" : "string",
                        "message" : "string",
                        "step_id" : "string"
                     }
                  ]
               },
               "healthy" : true,
               "history" : [
                  {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 0,
                              "integrations_server" : {
                                 "docker_image" : "string",
                                 "mode" : "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"
                              },
                              "size" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "zone_count" : 0
                           }
                        ],
                        "integrations_server" : {
                           "docker_image" : "string",
                           "mode" : "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"
                        },
                        "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  }
               ],
               "pending" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "error" : {
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "message" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z"
                  },
                  "healthy" : true,
                  "plan" : {
                     "cluster_topology" : [
                        {
                           "instance_configuration_id" : "string",
                           "instance_configuration_version" : 0,
                           "integrations_server" : {
                              "docker_image" : "string",
                              "mode" : "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"
                           },
                           "size" : {
                              "resource" : "string",
                              "value" : 0
                           },
                           "zone_count" : 0
                        }
                     ],
                     "integrations_server" : {
                        "docker_image" : "string",
                        "mode" : "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"
                     },
                     "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,
                              "details" : {
                                 "some_property" : "string"
                              },
                              "failure_type" : "string",
                              "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"
                  },
                  "warnings" : [
                     {
                        "code" : "string",
                        "message" : "string",
                        "step_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" : {
                        "config_version" : 0,
                        "id" : "string",
                        "name" : "string",
                        "resource" : "string"
                     },
                     "instance_name" : "string",
                     "instance_overrides" : {
                        "capacity" : 0,
                        "storage_multiplier" : 0.1
                     },
                     "maintenance_mode" : true,
                     "memory" : {
                        "instance_capacity" : 0,
                        "instance_capacity_planned" : 0,
                        "memory_pressure" : 0,
                        "native_memory_pressure" : 0
                     },
                     "node_roles" : [
                        "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" : {
               "aliased_endpoint" : "string",
               "aliased_url" : "string",
               "cloud_id" : "string",
               "endpoint" : "string",
               "last_modified" : "2019-01-01T00:00:00Z",
               "ports" : {
                  "http" : 0,
                  "https" : 0,
                  "transport_passthrough" : 0
               },
               "raw" : {},
               "service_url" : "string",
               "services_urls" : [
                  {
                     "service" : "string",
                     "url" : "string"
                  }
               ],
               "version" : 0
            },
            "plan_info" : {
               "current" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "error" : {
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "message" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z"
                  },
                  "healthy" : true,
                  "plan" : {
                     "cluster_topology" : [
                        {
                           "instance_configuration_id" : "string",
                           "instance_configuration_version" : 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"
                           },
                           "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,
                              "details" : {
                                 "some_property" : "string"
                              },
                              "failure_type" : "string",
                              "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"
                  },
                  "warnings" : [
                     {
                        "code" : "string",
                        "message" : "string",
                        "step_id" : "string"
                     }
                  ]
               },
               "healthy" : true,
               "history" : [
                  {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 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"
                              },
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  }
               ],
               "pending" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "error" : {
                     "details" : {
                        "some_property" : "string"
                     },
                     "failure_type" : "string",
                     "message" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z"
                  },
                  "healthy" : true,
                  "plan" : {
                     "cluster_topology" : [
                        {
                           "instance_configuration_id" : "string",
                           "instance_configuration_version" : 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"
                           },
                           "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,
                              "details" : {
                                 "some_property" : "string"
                              },
                              "failure_type" : "string",
                              "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"
                  },
                  "warnings" : [
                     {
                        "code" : "string",
                        "message" : "string",
                        "step_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" : {
                        "config_version" : 0,
                        "id" : "string",
                        "name" : "string",
                        "resource" : "string"
                     },
                     "instance_name" : "string",
                     "instance_overrides" : {
                        "capacity" : 0,
                        "storage_multiplier" : 0.1
                     },
                     "maintenance_mode" : true,
                     "memory" : {
                        "instance_capacity" : 0,
                        "instance_capacity_planned" : 0,
                        "memory_pressure" : 0,
                        "native_memory_pressure" : 0
                     },
                     "node_roles" : [
                        "string"
                     ],
                     "service_roles" : [
                        "string"
                     ],
                     "service_running" : true,
                     "service_version" : "string",
                     "zone" : "string"
                  }
               ]
            }
         },
         "ref_id" : "string",
         "region" : "string"
      }
   ]
}

DeploymentRestoreResponse

edit

A response returned from the Deployment restore endpoint

Properties

edit
id (string, required)
The id of the deployment

Example

edit
{
   "id" : "string"
}

DeploymentRoleAssignment

edit

Assignment for a role with deployment scope.

Properties

edit
all (boolean)
When true, the role applies to all deployments in the organization, otherwise the role is scoped to the deployments specified in deployment_ids.
application_roles (array[string])
If provided, the user assigned this role assignment will be granted this application role when signing in to the deployment(s) specified in the role assignment.
deployment_ids (array[string])
The IDs of the deployments the role is scoped to. Must be absent if all is true, and present if all is false.
organization_id (string, required)
The ID of the organization the role is scoped to.
role_id (string, required)
The ID of the role that is assigned.

Example

edit
{
   "all" : true,
   "application_roles" : [
      "string"
   ],
   "deployment_ids" : [
      "string"
   ],
   "organization_id" : "string",
   "role_id" : "string"
}

DeploymentSearchResponse

edit

Describes a searched Deployment

Properties

edit
alias (string)
A user-defined deployment alias for user-friendly resource URLs
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

Example

edit
{
   "alias" : "string",
   "healthy" : true,
   "id" : "string",
   "metadata" : {
      "byok_enabled" : true,
      "tags" : [
         {
            "key" : "string",
            "value" : "string"
         }
      ]
   },
   "name" : "string",
   "resources" : {
      "apm" : [
         {
            "elasticsearch_cluster_ref_id" : "string",
            "id" : "string",
            "info" : {
               "apm_server_mode" : "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,
               "id" : "string",
               "links" : {
                  "some_property" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "aliased_endpoint" : "string",
                  "aliased_url" : "string",
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "services_urls" : [
                     {
                        "service" : "string",
                        "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",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  },
                  "healthy" : true,
                  "history" : [
                     {
                        "attempt_end_time" : "2019-01-01T00:00:00Z",
                        "attempt_start_time" : "2019-01-01T00:00:00Z",
                        "error" : {
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "message" : "string",
                           "timestamp" : "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",
                                 "instance_configuration_version" : 0,
                                 "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,
                                    "details" : {
                                       "some_property" : "string"
                                    },
                                    "failure_type" : "string",
                                    "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"
                        },
                        "warnings" : [
                           {
                              "code" : "string",
                              "message" : "string",
                              "step_id" : "string"
                           }
                        ]
                     }
                  ],
                  "pending" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_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" : {
                           "config_version" : 0,
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "instance_overrides" : {
                           "capacity" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "node_roles" : [
                           "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" : {
                  "aliased_endpoint" : "string",
                  "aliased_url" : "string",
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "services_urls" : [
                     {
                        "service" : "string",
                        "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",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  },
                  "healthy" : true,
                  "history" : [
                     {
                        "attempt_end_time" : "2019-01-01T00:00:00Z",
                        "attempt_start_time" : "2019-01-01T00:00:00Z",
                        "error" : {
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "message" : "string",
                           "timestamp" : "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",
                                 "instance_configuration_version" : 0,
                                 "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,
                                    "details" : {
                                       "some_property" : "string"
                                    },
                                    "failure_type" : "string",
                                    "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"
                        },
                        "warnings" : [
                           {
                              "code" : "string",
                              "message" : "string",
                              "step_id" : "string"
                           }
                        ]
                     }
                  ],
                  "pending" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_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" : {
                           "config_version" : 0,
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "instance_overrides" : {
                           "capacity" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "node_roles" : [
                           "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
                        }
                     }
                  }
               ],
               "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"
                           ]
                        }
                     ]
                  },
                  "cluster_blocking_issues" : {
                     "blocks" : [
                        {
                           "description" : "string",
                           "level" : "string"
                        }
                     ],
                     "healthy" : true
                  },
                  "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
                        }
                     ]
                  },
                  "shards_status" : {
                     "status" : "string"
                  }
               },
               "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" : {
                  "aliased_endpoint" : "string",
                  "aliased_url" : "string",
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "services_urls" : [
                     {
                        "service" : "string",
                        "url" : "string"
                     }
                  ],
                  "version" : 0
               },
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "autoscaling_enabled" : true,
                        "cluster_topology" : [
                           {
                              "autoscaling_max" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "autoscaling_min" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "autoscaling_policy_override_json" : {},
                              "autoscaling_tier_override" : true,
                              "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
                                       }
                                    },
                                    "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"
                              },
                              "id" : "string",
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 0,
                              "node_roles" : [
                                 "string"
                              ],
                              "node_type" : {
                                 "data" : true,
                                 "ingest" : true,
                                 "master" : true,
                                 "ml" : true
                              },
                              "size" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "topology_element_control" : {
                                 "min" : {
                                    "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
                                 }
                              },
                              "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",
                                    "info" : {
                                       "compatible" : true,
                                       "connected" : true,
                                       "healthy" : true,
                                       "trusted" : true,
                                       "trusted_back" : true
                                    },
                                    "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  },
                  "healthy" : true,
                  "history" : [
                     {
                        "attempt_end_time" : "2019-01-01T00:00:00Z",
                        "attempt_start_time" : "2019-01-01T00:00:00Z",
                        "error" : {
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "message" : "string",
                           "timestamp" : "2019-01-01T00:00:00Z"
                        },
                        "healthy" : true,
                        "plan" : {
                           "autoscaling_enabled" : true,
                           "cluster_topology" : [
                              {
                                 "autoscaling_max" : {
                                    "resource" : "string",
                                    "value" : 0
                                 },
                                 "autoscaling_min" : {
                                    "resource" : "string",
                                    "value" : 0
                                 },
                                 "autoscaling_policy_override_json" : {},
                                 "autoscaling_tier_override" : true,
                                 "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
                                          }
                                       },
                                       "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"
                                 },
                                 "id" : "string",
                                 "instance_configuration_id" : "string",
                                 "instance_configuration_version" : 0,
                                 "node_roles" : [
                                    "string"
                                 ],
                                 "node_type" : {
                                    "data" : true,
                                    "ingest" : true,
                                    "master" : true,
                                    "ml" : true
                                 },
                                 "size" : {
                                    "resource" : "string",
                                    "value" : 0
                                 },
                                 "topology_element_control" : {
                                    "min" : {
                                       "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
                                    }
                                 },
                                 "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",
                                       "info" : {
                                          "compatible" : true,
                                          "connected" : true,
                                          "healthy" : true,
                                          "trusted" : true,
                                          "trusted_back" : true
                                       },
                                       "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,
                                    "details" : {
                                       "some_property" : "string"
                                    },
                                    "failure_type" : "string",
                                    "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"
                        },
                        "warnings" : [
                           {
                              "code" : "string",
                              "message" : "string",
                              "step_id" : "string"
                           }
                        ]
                     }
                  ],
                  "pending" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "autoscaling_enabled" : true,
                        "cluster_topology" : [
                           {
                              "autoscaling_max" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "autoscaling_min" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "autoscaling_policy_override_json" : {},
                              "autoscaling_tier_override" : true,
                              "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
                                       }
                                    },
                                    "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"
                              },
                              "id" : "string",
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 0,
                              "node_roles" : [
                                 "string"
                              ],
                              "node_type" : {
                                 "data" : true,
                                 "ingest" : true,
                                 "master" : true,
                                 "ml" : true
                              },
                              "size" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "topology_element_control" : {
                                 "min" : {
                                    "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
                                 }
                              },
                              "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",
                                    "info" : {
                                       "compatible" : true,
                                       "connected" : true,
                                       "healthy" : true,
                                       "trusted" : true,
                                       "trusted_back" : true
                                    },
                                    "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_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" : {
                  "curation" : {
                     "specs" : [
                        {
                           "index_pattern" : "string",
                           "trigger_interval_seconds" : 0
                        }
                     ]
                  },
                  "dedicated_masters_threshold" : 0,
                  "keystore_contents" : {
                     "secrets" : {
                        "some_property" : {
                           "as_file" : true,
                           "value" : {}
                        }
                     }
                  },
                  "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",
                           "name" : "string",
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ]
                        }
                     ],
                     "direct" : [
                        {
                           "additional_node_names" : [
                              "string"
                           ],
                           "certificates" : [
                              {
                                 "metadata" : {
                                    "also_trusted_by" : [
                                       "string"
                                    ],
                                    "fingerprint" : "string",
                                    "valid_from" : "2019-01-01T00:00:00Z",
                                    "valid_to" : "2019-01-01T00:00:00Z"
                                 },
                                 "pem" : "string"
                              }
                           ],
                           "name" : "string",
                           "scope_id" : "string",
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ],
                           "type" : "string",
                           "uid" : "string"
                        }
                     ],
                     "external" : [
                        {
                           "name" : "string",
                           "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" : {
                           "config_version" : 0,
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "instance_overrides" : {
                           "capacity" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "node_roles" : [
                           "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" : {
                  "aliased_endpoint" : "string",
                  "aliased_url" : "string",
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "services_urls" : [
                     {
                        "service" : "string",
                        "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",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  },
                  "healthy" : true,
                  "history" : [
                     {
                        "attempt_end_time" : "2019-01-01T00:00:00Z",
                        "attempt_start_time" : "2019-01-01T00:00:00Z",
                        "error" : {
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "message" : "string",
                           "timestamp" : "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",
                                 "instance_configuration_version" : 0,
                                 "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,
                                    "details" : {
                                       "some_property" : "string"
                                    },
                                    "failure_type" : "string",
                                    "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"
                        },
                        "warnings" : [
                           {
                              "code" : "string",
                              "message" : "string",
                              "step_id" : "string"
                           }
                        ]
                     }
                  ],
                  "pending" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "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",
                              "instance_configuration_version" : 0,
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_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" : {
                           "config_version" : 0,
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "instance_overrides" : {
                           "capacity" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "node_roles" : [
                           "string"
                        ],
                        "service_roles" : [
                           "string"
                        ],
                        "service_running" : true,
                        "service_version" : "string",
                        "zone" : "string"
                     }
                  ]
               }
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ],
      "integrations_server" : [
         {
            "elasticsearch_cluster_ref_id" : "string",
            "id" : "string",
            "info" : {
               "apm_server_mode" : "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,
               "id" : "string",
               "links" : {
                  "some_property" : {
                     "need_elevated_permissions" : true
                  }
               },
               "metadata" : {
                  "aliased_endpoint" : "string",
                  "aliased_url" : "string",
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "services_urls" : [
                     {
                        "service" : "string",
                        "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",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 0,
                              "integrations_server" : {
                                 "docker_image" : "string",
                                 "mode" : "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"
                              },
                              "size" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "zone_count" : 0
                           }
                        ],
                        "integrations_server" : {
                           "docker_image" : "string",
                           "mode" : "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"
                        },
                        "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  },
                  "healthy" : true,
                  "history" : [
                     {
                        "attempt_end_time" : "2019-01-01T00:00:00Z",
                        "attempt_start_time" : "2019-01-01T00:00:00Z",
                        "error" : {
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "message" : "string",
                           "timestamp" : "2019-01-01T00:00:00Z"
                        },
                        "healthy" : true,
                        "plan" : {
                           "cluster_topology" : [
                              {
                                 "instance_configuration_id" : "string",
                                 "instance_configuration_version" : 0,
                                 "integrations_server" : {
                                    "docker_image" : "string",
                                    "mode" : "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"
                                 },
                                 "size" : {
                                    "resource" : "string",
                                    "value" : 0
                                 },
                                 "zone_count" : 0
                              }
                           ],
                           "integrations_server" : {
                              "docker_image" : "string",
                              "mode" : "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"
                           },
                           "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,
                                    "details" : {
                                       "some_property" : "string"
                                    },
                                    "failure_type" : "string",
                                    "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"
                        },
                        "warnings" : [
                           {
                              "code" : "string",
                              "message" : "string",
                              "step_id" : "string"
                           }
                        ]
                     }
                  ],
                  "pending" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 0,
                              "integrations_server" : {
                                 "docker_image" : "string",
                                 "mode" : "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"
                              },
                              "size" : {
                                 "resource" : "string",
                                 "value" : 0
                              },
                              "zone_count" : 0
                           }
                        ],
                        "integrations_server" : {
                           "docker_image" : "string",
                           "mode" : "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"
                        },
                        "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_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" : {
                           "config_version" : 0,
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "instance_overrides" : {
                           "capacity" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "node_roles" : [
                           "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" : {
                  "aliased_endpoint" : "string",
                  "aliased_url" : "string",
                  "cloud_id" : "string",
                  "endpoint" : "string",
                  "last_modified" : "2019-01-01T00:00:00Z",
                  "ports" : {
                     "http" : 0,
                     "https" : 0,
                     "transport_passthrough" : 0
                  },
                  "raw" : {},
                  "service_url" : "string",
                  "services_urls" : [
                     {
                        "service" : "string",
                        "url" : "string"
                     }
                  ],
                  "version" : 0
               },
               "plan_info" : {
                  "current" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 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"
                              },
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_id" : "string"
                        }
                     ]
                  },
                  "healthy" : true,
                  "history" : [
                     {
                        "attempt_end_time" : "2019-01-01T00:00:00Z",
                        "attempt_start_time" : "2019-01-01T00:00:00Z",
                        "error" : {
                           "details" : {
                              "some_property" : "string"
                           },
                           "failure_type" : "string",
                           "message" : "string",
                           "timestamp" : "2019-01-01T00:00:00Z"
                        },
                        "healthy" : true,
                        "plan" : {
                           "cluster_topology" : [
                              {
                                 "instance_configuration_id" : "string",
                                 "instance_configuration_version" : 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"
                                 },
                                 "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,
                                    "details" : {
                                       "some_property" : "string"
                                    },
                                    "failure_type" : "string",
                                    "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"
                        },
                        "warnings" : [
                           {
                              "code" : "string",
                              "message" : "string",
                              "step_id" : "string"
                           }
                        ]
                     }
                  ],
                  "pending" : {
                     "attempt_end_time" : "2019-01-01T00:00:00Z",
                     "attempt_start_time" : "2019-01-01T00:00:00Z",
                     "error" : {
                        "details" : {
                           "some_property" : "string"
                        },
                        "failure_type" : "string",
                        "message" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     },
                     "healthy" : true,
                     "plan" : {
                        "cluster_topology" : [
                           {
                              "instance_configuration_id" : "string",
                              "instance_configuration_version" : 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"
                              },
                              "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,
                                 "details" : {
                                    "some_property" : "string"
                                 },
                                 "failure_type" : "string",
                                 "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"
                     },
                     "warnings" : [
                        {
                           "code" : "string",
                           "message" : "string",
                           "step_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" : {
                           "config_version" : 0,
                           "id" : "string",
                           "name" : "string",
                           "resource" : "string"
                        },
                        "instance_name" : "string",
                        "instance_overrides" : {
                           "capacity" : 0,
                           "storage_multiplier" : 0.1
                        },
                        "maintenance_mode" : true,
                        "memory" : {
                           "instance_capacity" : 0,
                           "instance_capacity_planned" : 0,
                           "memory_pressure" : 0,
                           "native_memory_pressure" : 0
                        },
                        "node_roles" : [
                           "string"
                        ],
                        "service_roles" : [
                           "string"
                        ],
                        "service_running" : true,
                        "service_version" : "string",
                        "zone" : "string"
                     }
                  ]
               }
            },
            "ref_id" : "string",
            "region" : "string"
         }
      ]
   },
   "settings" : {
      "auto_ops" : {
         "status" : "string"
      },
      "autoscaling_enabled" : true,
      "observability" : {
         "logging" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         },
         "metrics" : {
            "destination" : {
               "deployment_id" : "string",
               "ref_id" : "string"
            }
         }
      },
      "traffic_filter_settings" : {
         "rulesets" : [
            "string"
         ]
      }
   }
}

DeploymentSettings

edit

Additional configuration about the current deployment object.

Properties

edit
auto_ops (AutoOpsSettings, required)
See AutoOps integration status for this deployment.
autoscaling_enabled (boolean)
If autoscaling is enabled for this deployment.
observability (DeploymentObservabilitySettings)
Logging and monitoring settings for this deployment.
traffic_filter_settings (TrafficFilterSettings)
The traffic filter rulesets for this deployment.

Example

edit
{
   "auto_ops" : {
      "status" : "string"
   },
   "autoscaling_enabled" : true,
   "observability" : {
      "logging" : {
         "destination" : {
            "deployment_id" : "string",
            "ref_id" : "string"
         }
      },
      "metrics" : {
         "destination" : {
            "deployment_id" : "string",
            "ref_id" : "string"
         }
      }
   },
   "traffic_filter_settings" : {
      "rulesets" : [
         "string"
      ]
   }
}

DeploymentShutdownResponse

edit

A response returned from the Deployment shutdown endpoint

Properties

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

Example

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

DeploymentTemplateInfoV2

edit

Deployment template detailed information

Properties

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

Example

edit
{
   "deployment_template" : {
      "alias" : "string",
      "metadata" : {
         "tags" : [
            {
               "key" : "string",
               "value" : "string"
            }
         ]
      },
      "name" : "string",
      "region" : "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",
                        "instance_configuration_version" : 0,
                        "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",
                        "instance_configuration_version" : 0,
                        "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" : {
                  "autoscaling_enabled" : true,
                  "cluster_topology" : [
                     {
                        "autoscaling_max" : {
                           "resource" : "string",
                           "value" : 0
                        },
                        "autoscaling_min" : {
                           "resource" : "string",
                           "value" : 0
                        },
                        "autoscaling_policy_override_json" : {},
                        "autoscaling_tier_override" : true,
                        "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
                                 }
                              },
                              "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"
                        },
                        "id" : "string",
                        "instance_configuration_id" : "string",
                        "instance_configuration_version" : 0,
                        "node_roles" : [
                           "string"
                        ],
                        "node_type" : {
                           "data" : true,
                           "ingest" : true,
                           "master" : true,
                           "ml" : true
                        },
                        "size" : {
                           "resource" : "string",
                           "value" : 0
                        },
                        "topology_element_control" : {
                           "min" : {
                              "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
                           }
                        },
                        "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",
                              "info" : {
                                 "compatible" : true,
                                 "connected" : true,
                                 "healthy" : true,
                                 "trusted" : true,
                                 "trusted_back" : true
                              },
                              "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" : {
                  "curation" : {
                     "specs" : [
                        {
                           "index_pattern" : "string",
                           "trigger_interval_seconds" : 0
                        }
                     ]
                  },
                  "dedicated_masters_threshold" : 0,
                  "keystore_contents" : {
                     "secrets" : {
                        "some_property" : {
                           "as_file" : true,
                           "value" : {}
                        }
                     }
                  },
                  "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",
                           "name" : "string",
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ]
                        }
                     ],
                     "direct" : [
                        {
                           "additional_node_names" : [
                              "string"
                           ],
                           "certificates" : [
                              {
                                 "metadata" : {
                                    "also_trusted_by" : [
                                       "string"
                                    ],
                                    "fingerprint" : "string",
                                    "valid_from" : "2019-01-01T00:00:00Z",
                                    "valid_to" : "2019-01-01T00:00:00Z"
                                 },
                                 "pem" : "string"
                              }
                           ],
                           "name" : "string",
                           "scope_id" : "string",
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ],
                           "type" : "string",
                           "uid" : "string"
                        }
                     ],
                     "external" : [
                        {
                           "name" : "string",
                           "trust_all" : true,
                           "trust_allowlist" : [
                              "string"
                           ],
                           "trust_relationship_id" : "string"
                        }
                     ]
                  }
               }
            }
         ],
         "enterprise_search" : [
            {
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "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",
                        "instance_configuration_version" : 0,
                        "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" : {}
                     }
                  }
               },
               "ref_id" : "string",
               "region" : "string",
               "settings" : {
                  "metadata" : {
                     "name" : "string"
                  }
               }
            }
         ],
         "integrations_server" : [
            {
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "plan" : {
                  "cluster_topology" : [
                     {
                        "instance_configuration_id" : "string",
                        "instance_configuration_version" : 0,
                        "integrations_server" : {
                           "docker_image" : "string",
                           "mode" : "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"
                        },
                        "size" : {
                           "resource" : "string",
                           "value" : 0
                        },
                        "zone_count" : 0
                     }
                  ],
                  "integrations_server" : {
                     "docker_image" : "string",
                     "mode" : "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"
                  },
                  "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"
                  }
               }
            }
         ],
         "kibana" : [
            {
               "display_name" : "string",
               "elasticsearch_cluster_ref_id" : "string",
               "plan" : {
                  "cluster_topology" : [
                     {
                        "instance_configuration_id" : "string",
                        "instance_configuration_version" : 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"
                        },
                        "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" : {
         "autoscaling_enabled" : true,
         "observability" : {
            "logging" : {
               "destination" : {
                  "deployment_id" : "string",
                  "ref_id" : "string"
               }
            },
            "metrics" : {
               "destination" : {
                  "deployment_id" : "string",
                  "ref_id" : "string"
               }
            }
         },
         "traffic_filter_settings" : {
            "rulesets" : [
               "string"
            ]
         }
      },
      "version" : "string"
   },
   "description" : "string",
   "id" : "string",
   "instance_configurations" : [
      {
         "config_version" : 0,
         "cpu_multiplier" : 0.1,
         "description" : "string",
         "discrete_sizes" : {
            "default_size" : 0,
            "resource" : "string",
            "sizes" : [
               0
            ]
         },
         "id" : "string",
         "instance_type" : "string",
         "max_zones" : 0,
         "metadata" : {},
         "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"
}

DeploymentTemplateReference

edit

Specifies the deployment template used to create the plan.

Properties

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

Example

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

DeploymentUpdateMetadata

edit

Additional information about the current deployment object.

Properties

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

Example

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

DeploymentUpdateRequest

edit

A request for updating a Deployment consisting of multiple resources

Properties

edit
alias (string)
A user-defined alias to use in place of Cluster IDs for user-friendly URLs
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.

Example

edit
{
   "alias" : "string",
   "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",