Definitions

AllocatedInstancePlansInfo

The plan information for the Elasticsearch cluster associated with the Kibana instance or APM Server.

Properties

pending (boolean, required)
Whether or not there is a pending plan.
version (string)
The version of the current plan, falling back to that of the pending plan if it exists.
zone_count (integer as int32)
The number of zones in the current plan, falling back to that of the pending plan if it exists.

Example

{
   "pending" : true,
   "version" : "string",
   "zone_count" : 0
}

AllocatedInstanceStatus

The status of the allocated Kibana instance or APM Server.

Properties

cluster_healthy (boolean)
Indicates whether the cluster the instance belongs to is healthy
cluster_id (string, required)
Identifier for the cluster this instance belongs
cluster_name (string)
Name of cluster this instance belongs, if available
cluster_type (string, required)
Type of instance that is running. E.g. elasticsearch, kibana
healthy (boolean)
Indicates whether the instance is healthy
instance_configuration_id (string)
The instance configuration id of this instance
instance_name (string, required)
Instance ID of the instance
moving (boolean)
Indicates whether the instance is vacating away from this allocator. Note that this is currently not populated when returned from the search endpoint.
node_memory (integer as int32, required)
Memory assigned to this instance
plans_info (AllocatedInstancePlansInfo)
The plans associated with the current instance. Note that this is currently not populated when returned from the search endpoint.

Example

{
   "cluster_healthy" : true,
   "cluster_id" : "string",
   "cluster_name" : "string",
   "cluster_type" : "string",
   "healthy" : true,
   "instance_configuration_id" : "string",
   "instance_name" : "string",
   "moving" : true,
   "node_memory" : 0,
   "plans_info" : {
      "pending" : true,
      "version" : "string",
      "zone_count" : 0
   }
}

AllocatorBuildInfo

Information about the build that is running on the allocator.

Properties

commit_hash (string)
Git commit hash
version (string)
Version of the artifact

Example

{
   "commit_hash" : "string",
   "version" : "string"
}

AllocatorCapacity

The total and used capacity of the allocator.

Properties

memory (AllocatorCapacityMemory, required)
The available and used memory of the allocator.

Example

{
   "memory" : {
      "total" : 0,
      "used" : 0
   }
}

AllocatorCapacityMemory

The available and used memory of the allocator.

Properties

total (integer as int32, required)
Total memory in MB capacity installed on this allocator
used (integer as int32, required)
Used memory in MB used by instances assigned to this allocator

Example

{
   "total" : 0,
   "used" : 0
}

AllocatorHealthStatus

The health status of the allocator.

Properties

connected (boolean, required)
Whether the allocator is connected
healthy (boolean, required)
Whether the allocator is healthy, meaning it is either connected or has no instances
maintenance_mode (boolean, required)
Whether the allocator is in maintenance mode (meaning that new workload won't be assigned to it)

Example

{
   "connected" : true,
   "healthy" : true,
   "maintenance_mode" : true
}

AllocatorInfo

The overview information for the allocator.

Properties

allocator_id (string, required)
Identifier for this allocator
build_info (AllocatorBuildInfo)
Build Info of the artifact
capacity (AllocatorCapacity, required)
The total and used capacity of the allocator.
features (array[string])
List of features associated with this allocator. Note this is only present for backwards compatibility purposes and is scheduled for removal in the next major version release.
host_ip (string, required)
Host IP of this allocator
instances (array[AllocatedInstanceStatus], required)
metadata (array[MetadataItem], required)
Arbitrary metadata associated with this allocator
public_hostname (string, required)
Public hostname of this allocator
region (string)
The region that this allocator belongs to. Only populated in SaaS or federated ECE.
settings (AllocatorSettings, required)
The settings for the allocator.
status (AllocatorHealthStatus)
The health status of the allocator.
zone_id (string, required)
Identifier of the zone

Example

{
   "allocator_id" : "string",
   "build_info" : {
      "commit_hash" : "string",
      "version" : "string"
   },
   "capacity" : {
      "memory" : {
         "total" : 0,
         "used" : 0
      }
   },
   "features" : [
      "string"
   ],
   "host_ip" : "string",
   "instances" : [
      {
         "cluster_healthy" : true,
         "cluster_id" : "string",
         "cluster_name" : "string",
         "cluster_type" : "string",
         "healthy" : true,
         "instance_configuration_id" : "string",
         "instance_name" : "string",
         "moving" : true,
         "node_memory" : 0,
         "plans_info" : {
            "pending" : true,
            "version" : "string",
            "zone_count" : 0
         }
      }
   ],
   "metadata" : [
      {
         "key" : "string",
         "value" : "string"
      }
   ],
   "public_hostname" : "string",
   "region" : "string",
   "settings" : {
      "capacity" : 0
   },
   "status" : {
      "connected" : true,
      "healthy" : true,
      "maintenance_mode" : true
   },
   "zone_id" : "string"
}

AllocatorMoveRequest

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

Properties

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

Example

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

AllocatorOverview

The overview information for the installed allocators.

Properties

zones (array[AllocatorZoneInfo], required)

Example

{
   "zones" : [
      {
         "allocators" : [
            {
               "allocator_id" : "string",
               "build_info" : {
                  "commit_hash" : "string",
                  "version" : "string"
               },
               "capacity" : {
                  "memory" : {
                     "total" : 0,
                     "used" : 0
                  }
               },
               "features" : [
                  "string"
               ],
               "host_ip" : "string",
               "instances" : [
                  {
                     "cluster_healthy" : true,
                     "cluster_id" : "string",
                     "cluster_name" : "string",
                     "cluster_type" : "string",
                     "healthy" : true,
                     "instance_configuration_id" : "string",
                     "instance_name" : "string",
                     "moving" : true,
                     "node_memory" : 0,
                     "plans_info" : {
                        "pending" : true,
                        "version" : "string",
                        "zone_count" : 0
                     }
                  }
               ],
               "metadata" : [
                  {
                     "key" : "string",
                     "value" : "string"
                  }
               ],
               "public_hostname" : "string",
               "region" : "string",
               "settings" : {
                  "capacity" : 0
               },
               "status" : {
                  "connected" : true,
                  "healthy" : true,
                  "maintenance_mode" : true
               },
               "zone_id" : "string"
            }
         ],
         "zone_id" : "string"
      }
   ]
}

AllocatorSettings

The settings for the allocator.

Properties

capacity (integer as int32)
A memory capacity (in MB) that overrides the capacity defined during installation

Example

{
   "capacity" : 0
}

AllocatorZoneInfo

The allocators for the specified zone.

Properties

allocators (array[AllocatorInfo], required)
zone_id (string, required)
Identifier of the zone

Example

{
   "allocators" : [
      {
         "allocator_id" : "string",
         "build_info" : {
            "commit_hash" : "string",
            "version" : "string"
         },
         "capacity" : {
            "memory" : {
               "total" : 0,
               "used" : 0
            }
         },
         "features" : [
            "string"
         ],
         "host_ip" : "string",
         "instances" : [
            {
               "cluster_healthy" : true,
               "cluster_id" : "string",
               "cluster_name" : "string",
               "cluster_type" : "string",
               "healthy" : true,
               "instance_configuration_id" : "string",
               "instance_name" : "string",
               "moving" : true,
               "node_memory" : 0,
               "plans_info" : {
                  "pending" : true,
                  "version" : "string",
                  "zone_count" : 0
               }
            }
         ],
         "metadata" : [
            {
               "key" : "string",
               "value" : "string"
            }
         ],
         "public_hostname" : "string",
         "region" : "string",
         "settings" : {
            "capacity" : 0
         },
         "status" : {
            "connected" : true,
            "healthy" : true,
            "maintenance_mode" : true
         },
         "zone_id" : "string"
      }
   ],
   "zone_id" : "string"
}

ApmConfiguration

The configuration options for the APM Server.

Properties

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

Example

{
   "docker_image" : "string",
   "system_settings" : {
      "debug_enabled" : "string",
      "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

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

Properties

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)
The secret token for accessing the server

Example

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

ApmInfo

The overview information for the APM Server.

Properties

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

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

ApmPlan

The plan for the APM Server.

Properties

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

Example

{
   "apm" : {
      "docker_image" : "string",
      "system_settings" : {
         "debug_enabled" : "string",
         "elasticsearch_password" : "string",
         "elasticsearch_url" : "string",
         "elasticsearch_username" : "string",
         "kibana_url" : "string",
         "secret_token" : "string"
      },
      "user_settings_json" : {},
      "user_settings_override_json" : {},
      "user_settings_override_yaml" : "string",
      "user_settings_yaml" : "string",
      "version" : "string"
   },
   "cluster_topology" : [
      {
         "apm" : null,
         "instance_configuration_id" : "string",
         "size" : {
            "resource" : "string",
            "value" : 0
         },
         "zone_count" : 0
      }
   ],
   "transient" : {
      "plan_configuration" : {
         "calm_wait_time" : 0,
         "cluster_reboot" : "string",
         "extended_maintenance" : true,
         "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" : {
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   }
}

ApmPlanControlConfiguration

The plan control configuration options for the APM Server.

Properties

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

Example

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

ApmPlanInfo

Information about the APM Server plan.

Properties

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

Example

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

ApmPlansInfo

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

Properties

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

Example

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

ApmSettings

The settings for the APM Server.

Properties

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

Example

{
   "metadata" : {
      "contact_email" : "string",
      "hidden" : true,
      "name" : "string",
      "owner_id" : "string",
      "resources" : {
         "cpu" : {
            "boost" : true,
            "hard_limit" : true
         }
      },
      "subscription_level" : "string",
      "system_owned" : true
   }
}

ApmSubInfo

Information about the APM Servers associated with the Elasticsearch cluster.

Properties

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

Example

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

ApmSystemSettings

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

Properties

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

Example

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

ApmTopologyElement

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

Properties

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

Example

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

ApmsInfo

A container for information about a set of APM Servers.

Properties

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

Example

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

AvailableAuthenticationMethods

Specifies the authentication methods that are enabled on the Elasticsearch cluster. NOTE: When all fields are false, only the Platform admin and Platform viewer are available.

Properties

password (boolean, required)
Indicates that username and password authentication is available.
saml (boolean, required)
Indicates that SAML single sign-on authentication is available.

Example

{
   "password" : true,
   "saml" : true
}

BasicFailedReply

Intentionally left blank

Properties

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

Example

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

BasicFailedReplyElement

Intentionally left blank

Properties

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

Example

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

BoolQuery

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

Properties

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

Example

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

CapacityConstraintsResource

Specifies the maximum and minimum capacity constraints.

Properties

max (integer as int64, required)
Max capacity
min (integer as int64, required)
Min capacity

Example

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

ChangeSourceInfo

A container for information about the source of a change.

Properties

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

Example

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

ClusterCommandResponse

The response to an Elasticsearch cluster or Kibana instance command.

Properties

calculated_apm_plan (TransientApmPlanConfiguration)
If validating the command only, then the calculated Apm plan that would be applied.
calculated_elasticsearch_plan (TransientElasticsearchPlanConfiguration)
If validating the command only, then the calculated Elasticsearch plan that would be applied.
calculated_kibana_plan (TransientKibanaPlanConfiguration)
If validating the command only, then the calculated Kibana plan that would be applied.

Example

{
   "calculated_apm_plan" : {
      "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" : {
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   },
   "calculated_elasticsearch_plan" : {
      "cluster_settings_json" : {},
      "plan_configuration" : {
         "calm_wait_time" : 0,
         "cluster_reboot" : "string",
         "extended_maintenance" : true,
         "max_snapshot_age" : 0,
         "max_snapshot_attempts" : 0,
         "move_allocators" : [
            null
         ],
         "move_instances" : [
            null
         ],
         "move_only" : true,
         "override_failsafe" : true,
         "preferred_allocators" : [
            "string"
         ],
         "reallocate_instances" : true,
         "skip_data_migration" : true,
         "skip_post_upgrade_steps" : true,
         "skip_snapshot" : true,
         "skip_upgrade_checker" : true,
         "timeout" : 0
      },
      "restore_snapshot" : {
         "repository_config" : {
            "raw_settings" : {}
         },
         "repository_name" : "string",
         "restore_payload" : {
            "indices" : [
               "string"
            ],
            "raw_settings" : {}
         },
         "snapshot_name" : "string",
         "source_cluster_id" : "string",
         "strategy" : "string"
      },
      "strategy" : null
   },
   "calculated_kibana_plan" : {
      "plan_configuration" : {
         "calm_wait_time" : 0,
         "cluster_reboot" : "string",
         "extended_maintenance" : true,
         "move_allocators" : [
            null
         ],
         "move_instances" : [
            null
         ],
         "preferred_allocators" : [
            "string"
         ],
         "reallocate_instances" : true,
         "timeout" : 0
      },
      "strategy" : null
   }
}

ClusterCredentials

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

Properties

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

Example

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

ClusterCrudResponse

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

Properties

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

Example

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

ClusterCurationSettings

The index curation settings for an Elasticsearch cluster.

Properties

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

Example

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

ClusterCurationSpec

Specifies the conditions to trigger an Elasticsearch cluster curation.

Properties

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

Example

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

ClusterInfo

A container for information about an Elasticsearch cluster, Kibana instance, or APM Server.

Properties

apm (ApmInfo)
The top level info object for APM
elasticsearch (ElasticsearchClusterInfo)
The top-level object information for an Elasticsearch cluster.
kibana (KibanaClusterInfo)
The top level info object for a Kibana cluster

Example

{
   "apm" : {
      "elasticsearch_cluster" : {
         "elasticsearch_id" : "string",
         "links" : {
            "some_property" : {
               "need_elevated_permissions" : true
            }
         }
      },
      "external_links" : [
         {
            "id" : "string",
            "label" : "string",
            "uri" : "string"
         }
      ],
      "healthy" : true,
      "id" : "string",
      "links" : {
         "some_property" : null
      },
      "metadata" : {
         "cloud_id" : "string",
         "endpoint" : "string",
         "last_modified" : "2019-01-01T00:00:00Z",
         "ports" : {
            "http" : 0,
            "https" : 0
         },
         "raw" : {},
         "version" : 0
      },
      "name" : "string",
      "plan_info" : {
         "current" : {
            "attempt_end_time" : "2019-01-01T00:00:00Z",
            "attempt_start_time" : "2019-01-01T00:00:00Z",
            "healthy" : true,
            "plan" : {
               "apm" : {
                  "docker_image" : "string",
                  "system_settings" : {
                     "debug_enabled" : "string",
                     "elasticsearch_password" : "string",
                     "elasticsearch_url" : "string",
                     "elasticsearch_username" : "string",
                     "kibana_url" : "string",
                     "secret_token" : "string"
                  },
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "cluster_topology" : [
                  {
                     "apm" : null,
                     "instance_configuration_id" : "string",
                     "size" : {
                        "resource" : "string",
                        "value" : 0
                     },
                     "zone_count" : 0
                  }
               ],
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "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" : {
                     "grow_and_shrink" : {},
                     "rolling" : {
                        "allow_inline_resize" : true,
                        "group_by" : "string",
                        "shard_init_wait_time" : 0,
                        "skip_synced_flush" : true
                     },
                     "rolling_grow_and_shrink" : {}
                  }
               }
            },
            "plan_attempt_id" : "string",
            "plan_attempt_log" : [
               {
                  "completed" : "2019-01-01T00:00:00Z",
                  "duration_in_millis" : 0,
                  "info_log" : [
                     {
                        "delta_in_millis" : 0,
                        "message" : "string",
                        "stage" : "string",
                        "timestamp" : "2019-01-01T00:00:00Z"
                     }
                  ],
                  "stage" : "string",
                  "started" : "2019-01-01T00:00:00Z",
                  "status" : "string",
                  "step_id" : "string"
               }
            ],
            "plan_attempt_name" : "string",
            "plan_end_time" : "2019-01-01T00:00:00Z",
            "source" : {
               "action" : "string",
               "admin_id" : "string",
               "date" : "2019-01-01T00:00:00Z",
               "facilitator" : "string",
               "remote_addresses" : [
                  "string"
               ],
               "user_id" : "string"
            }
         },
         "healthy" : true,
         "history" : [
            null
         ],
         "pending" : null
      },
      "region" : "string",
      "settings" : {
         "metadata" : {
            "contact_email" : "string",
            "hidden" : true,
            "name" : "string",
            "owner_id" : "string",
            "resources" : {
               "cpu" : {
                  "boost" : true,
                  "hard_limit" : true
               }
            },
            "subscription_level" : "string",
            "system_owned" : true
         }
      },
      "status" : "string",
      "topology" : {
         "healthy" : true,
         "instances" : [
            {
               "allocator_id" : "string",
               "container_started" : true,
               "disk" : {
                  "disk_space_available" : 0,
                  "disk_space_used" : 0,
                  "storage_multiplier" : 0.1
               },
               "healthy" : true,
               "instance_configuration" : {
                  "id" : "string",
                  "name" : "string",
                  "resource" : "string"
               },
               "instance_name" : "string",
               "maintenance_mode" : true,
               "memory" : {
                  "instance_capacity" : 0,
                  "instance_capacity_planned" : 0,
                  "memory_pressure" : 0,
                  "native_memory_pressure" : 0
               },
               "service_id" : "string",
               "service_roles" : [
                  "string"
               ],
               "service_running" : true,
               "service_version" : "string",
               "zone" : "string"
            }
         ]
      }
   },
   "elasticsearch" : {
      "associated_apm_clusters" : [
         {
            "apm_id" : "string",
            "enabled" : true,
            "links" : {
               "some_property" : null
            }
         }
      ],
      "associated_kibana_clusters" : [
         {
            "enabled" : true,
            "kibana_id" : "string",
            "links" : {
               "some_property" : null
            }
         }
      ],
      "ccs" : {
         "healthy" : true,
         "remote_clusters" : [
            {
               "compatible" : true,
               "id" : "string",
               "version" : "string"
            }
         ]
      },
      "cluster_id" : "string",
      "cluster_name" : "string",
      "elasticsearch" : {
         "blocking_issues" : {
            "cluster_level" : [
               {
                  "description" : "string",
                  "instances" : [
                     "string"
                  ]
               }
            ],
            "healthy" : true,
            "index_level" : [
               null
            ]
         },
         "healthy" : true,
         "master_info" : {
            "healthy" : true,
            "instances_with_no_master" : [
               "string"
            ],
            "masters" : [
               {
                  "instances" : [
                     "string"
                  ],
                  "master_instance_name" : "string",
                  "master_node_id" : "string"
               }
            ]
         },
         "shard_info" : {
            "available_shards" : [
               {
                  "instance_name" : "string",
                  "shard_count" : 0
               }
            ],
            "healthy" : true,
            "unavailable_replicas" : [
               {
                  "instance_name" : "string",
                  "replica_count" : 0
               }
            ],
            "unavailable_shards" : [
               null
            ]
         }
      },
      "elasticsearch_monitoring_info" : {
         "destination_cluster_ids" : [
            "string"
         ],
         "healthy" : true,
         "last_modified" : "2019-01-01T00:00:00Z",
         "last_update_status" : "string",
         "source_cluster_ids" : [
            "string"
         ]
      },
      "external_links" : [
         null
      ],
      "healthy" : true,
      "links" : {
         "some_property" : null
      },
      "locked" : true,
      "metadata" : null,
      "plan_info" : {
         "current" : {
            "attempt_end_time" : "2019-01-01T00:00:00Z",
            "attempt_start_time" : "2019-01-01T00:00:00Z",
            "healthy" : true,
            "plan" : {
               "cluster_topology" : [
                  {
                     "allocator_filter" : {},
                     "elasticsearch" : {
                        "curation" : {
                           "from_instance_configuration_id" : "string",
                           "to_instance_configuration_id" : "string"
                        },
                        "docker_image" : "string",
                        "enabled_built_in_plugins" : [
                           "string"
                        ],
                        "node_attributes" : {
                           "some_property" : "string"
                        },
                        "system_settings" : {
                           "auto_create_index" : true,
                           "default_shards_per_index" : 0,
                           "destructive_requires_name" : true,
                           "enable_close_index" : true,
                           "monitoring_collection_interval" : 0,
                           "monitoring_history_duration" : "string",
                           "reindex_whitelist" : [
                              "string"
                           ],
                           "scripting" : {
                              "expressions_enabled" : true,
                              "file" : {
                                 "enabled" : true,
                                 "sandbox_mode" : true
                              },
                              "inline" : null,
                              "mustache_enabled" : true,
                              "painless_enabled" : true,
                              "stored" : null
                           },
                           "use_disk_threshold" : true,
                           "watcher_trigger_engine" : "string"
                        },
                        "user_bundles" : [
                           {
                              "elasticsearch_version" : "string",
                              "name" : "string",
                              "url" : "string"
                           }
                        ],
                        "user_plugins" : [
                           {
                              "elasticsearch_version" : "string",
                              "name" : "string",
                              "url" : "string"
                           }
                        ],
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "instance_configuration_id" : "string",
                     "memory_per_node" : 0,
                     "node_configuration" : "string",
                     "node_count_per_zone" : 0,
                     "node_type" : {
                        "data" : true,
                        "ingest" : true,
                        "master" : true,
                        "ml" : true
                     },
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "deployment_template" : {
                  "id" : "string",
                  "version" : "string"
               },
               "elasticsearch" : null,
               "tiebreaker_override" : true,
               "tiebreaker_topology" : {
                  "memory_per_node" : 0
               },
               "transient" : {
                  "cluster_settings_json" : {},
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "max_snapshot_age" : 0,
                     "max_snapshot_attempts" : 0,
                     "move_allocators" : [
                        null
                     ],
                     "move_instances" : [
                        null
                     ],
                     "move_only" : true,
                     "override_failsafe" : true,
                     "preferred_allocators" : [
                        "string"
                     ],
                     "reallocate_instances" : true,
                     "skip_data_migration" : true,
                     "skip_post_upgrade_steps" : true,
                     "skip_snapshot" : true,
                     "skip_upgrade_checker" : true,
                     "timeout" : 0
                  },
                  "restore_snapshot" : {
                     "repository_config" : {
                        "raw_settings" : {}
                     },
                     "repository_name" : "string",
                     "restore_payload" : {
                        "indices" : [
                           "string"
                        ],
                        "raw_settings" : {}
                     },
                     "snapshot_name" : "string",
                     "source_cluster_id" : "string",
                     "strategy" : "string"
                  },
                  "strategy" : null
               },
               "zone_count" : 0
            },
            "plan_attempt_id" : "string",
            "plan_attempt_log" : [
               null
            ],
            "plan_attempt_name" : "string",
            "plan_end_time" : "2019-01-01T00:00:00Z",
            "source" : null
         },
         "healthy" : true,
         "history" : [
            null
         ],
         "pending" : null
      },
      "region" : "string",
      "security" : {
         "last_modified" : "2019-01-01T00:00:00Z",
         "roles" : {},
         "users" : [
            {
               "password_hash" : "string",
               "username" : "string"
            }
         ],
         "users_roles" : [
            {
               "roles" : [
                  "string"
               ],
               "username" : "string"
            }
         ],
         "version" : 0
      },
      "settings" : {
         "ccs" : {
            "remote_clusters" : {
               "some_property" : {
                  "cluster_id" : "string",
                  "skip_unavailable" : true
               }
            }
         },
         "curation" : {
            "specs" : [
               {
                  "index_pattern" : "string",
                  "trigger_interval_seconds" : 0
               }
            ]
         },
         "dedicated_masters_threshold" : 0,
         "ip_filtering" : {
            "rulesets" : [
               "string"
            ]
         },
         "metadata" : null,
         "monitoring" : {
            "target_cluster_id" : "string"
         },
         "snapshot" : {
            "enabled" : true,
            "interval" : "string",
            "pending_interval" : "string",
            "repository" : {
               "default" : {},
               "reference" : {
                  "repository_name" : "string"
               },
               "static" : {
                  "repository_type" : "string",
                  "settings" : {}
               }
            },
            "repository_name" : "string",
            "retention" : {
               "max_age" : "string",
               "snapshots" : 0
            },
            "suspended" : [
               "string"
            ],
            "wait_time_after_snapshotting" : "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",
            "instance_name" : "string",
            "timestamp" : "2019-01-01T00:00:00Z",
            "url" : "string"
         }
      ],
      "topology" : null
   },
   "kibana" : {
      "cluster_id" : "string",
      "cluster_name" : "string",
      "elasticsearch_cluster" : null,
      "external_links" : [
         null
      ],
      "healthy" : true,
      "links" : {
         "some_property" : null
      },
      "metadata" : null,
      "plan_info" : {
         "current" : {
            "attempt_end_time" : "2019-01-01T00:00:00Z",
            "attempt_start_time" : "2019-01-01T00:00:00Z",
            "healthy" : true,
            "plan" : {
               "cluster_topology" : [
                  {
                     "allocator_filter" : {},
                     "instance_configuration_id" : "string",
                     "kibana" : {
                        "docker_image" : "string",
                        "system_settings" : {
                           "elasticsearch_password" : "string",
                           "elasticsearch_url" : "string",
                           "elasticsearch_username" : "string"
                        },
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "memory_per_node" : 0,
                     "node_configuration" : "string",
                     "node_count_per_zone" : 0,
                     "size" : null,
                     "zone_count" : 0
                  }
               ],
               "kibana" : null,
               "transient" : {
                  "plan_configuration" : {
                     "calm_wait_time" : 0,
                     "cluster_reboot" : "string",
                     "extended_maintenance" : true,
                     "move_allocators" : [
                        null
                     ],
                     "move_instances" : [
                        null
                     ],
                     "preferred_allocators" : [
                        "string"
                     ],
                     "reallocate_instances" : true,
                     "timeout" : 0
                  },
                  "strategy" : null
               },
               "zone_count" : 0
            },
            "plan_attempt_id" : "string",
            "plan_attempt_log" : [
               null
            ],
            "plan_attempt_name" : "string",
            "plan_end_time" : "2019-01-01T00:00:00Z",
            "source" : null
         },
         "healthy" : true,
         "history" : [
            null
         ],
         "pending" : null
      },
      "region" : "string",
      "settings" : {
         "metadata" : null
      },
      "status" : "string",
      "topology" : null
   }
}

ClusterInstanceConfigurationInfo

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

Properties

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

Example

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

ClusterInstanceDiskInfo

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

Properties

disk_space_available (integer as int64)
If known, the amount of 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)
The storage multiplier originally defined to calculate disk space.

Example

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

ClusterInstanceInfo

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

Properties

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

Example

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

ClusterInstanceMemoryInfo

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

Properties

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

Example

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

ClusterLicenseInfo

Information about the Elasticsearch cluster license.

Properties

license (object, required)
Object containing the cluster license data

Example

{
   "license" : {}
}

ClusterMetadataCpuResourcesSettings

Specifies the CPU resource settings for the Elasticsearch cluster.

Properties

boost (boolean, required)
Indicates if the the CPU boost flag for a cluster is enabled or not
hard_limit (boolean, required)
Indicates if the the CPU hard limit flag for a cluster is enabled or not

Example

{
   "boost" : true,
   "hard_limit" : true
}

ClusterMetadataInfo

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

Properties

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

Example

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

ClusterMetadataPortInfo

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

Properties

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

Example

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

ClusterMetadataResourcesSettings

The top-level configuration settings for the Elasticsearch cluster resources.

Properties

cpu (ClusterMetadataCpuResourcesSettings)
Specifies the CPU resource settings for the Elasticsearch cluster.

Example

{
   "cpu" : {
      "boost" : true,
      "hard_limit" : true
   }
}

ClusterMetadataSettings

The top-level configuration settings for the Elasticsearch cluster.

Properties

contact_email (string)
Contact email for the cluster
hidden (boolean)
Whether or not this cluster is hidden from the normal clusters list
name (string)
The display name of the cluster
owner_id (string)
The user id (referencing whatever user database is in use) of the cluster owner
resources (ClusterMetadataResourcesSettings)
The top-level configuration settings for the Elasticsearch cluster resources.
subscription_level (string)
Subscription level of the cluster
system_owned (boolean)
Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)

Example

{
   "contact_email" : "string",
   "hidden" : true,
   "name" : "string",
   "owner_id" : "string",
   "resources" : {
      "cpu" : {
         "boost" : true,
         "hard_limit" : true
      }
   },
   "subscription_level" : "string",
   "system_owned" : true
}

ClusterPlanMigrationResponse

The response from migrating an Elasticsearch cluster plan to a new template.

Properties

elasticsearch_cluster_id (string)
The ID of the Elasticsearch cluster
plan (string)
The cluster plan after applying the migration

Example

{
   "elasticsearch_cluster_id" : "string",
   "plan" : "string"
}

ClusterPlanStepInfo

Information about a step in a plan.

Properties

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

Example

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

ClusterPlanStepLogMessageInfo

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

Properties

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

Example

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

ClusterSnapshotRepositoryDefault

The default object for the Elasticsearch cluster snapshot repository.

Example

{}

ClusterSnapshotRepositoryInfo

Information about the Elasticsearch cluster snapshot repository.

Properties

default (ClusterSnapshotRepositoryDefault)
Cluster snapshot default repository settings
reference (ClusterSnapshotRepositoryReference)
Cluster snapshot reference repository settings, containing the repository name in ECE fashion
static (ClusterSnapshotRepositoryStatic)
Cluster snapshot static repository settings, containing repository type and settings

Example

{
   "default" : {},
   "reference" : {
      "repository_name" : "string"
   },
   "static" : {
      "repository_type" : "string",
      "settings" : {}
   }
}

ClusterSnapshotRepositoryReference

The reference object for the Elasticsearch cluster snapshot repository.

Properties

repository_name (string)
ECE snapshot repository name, from the '/platform/configuration/snapshots/repositories' endpoint

Example

{
   "repository_name" : "string"
}

ClusterSnapshotRepositoryStatic

The static object for the Elasticsearch cluster snapshot repository.

Properties

repository_type (string)
Type of snapshot repository, ie: S3
settings (object)
Settings associated with snapshot repository

Example

{
   "repository_type" : "string",
   "settings" : {}
}

ClusterSnapshotRequest

The settings for a snapshot create request.

Properties

name (string)
The optional name for the snapshot
password (string)
The optional snapshot repository password. When the snapshot repository password is unspecified, the default repository password is used.
repository_name (string)
The optional snapshot repository. When the repository is unspecified, the default repository is used.
username (string)
The optional snapshot repository username. When the snapshot repository username is unspecified, the default repository username is used.

Example

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

ClusterSnapshotResponse

The response value after a snapshot is created.

Properties

name (string)
The name of the newly created snapshot

Example

{
   "name" : "string"
}

ClusterSnapshotRetention

Information about the Elasticsearch cluster snapshot retention.

Properties

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

Example

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

ClusterSnapshotSettings

The snapshot configuration settings for an Elasticsearch cluster.

Properties

enabled (boolean)
Indicates if Snapshotting is enabled
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
pending_interval (string)
Interval between snapshot progress checks, with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 1 minute
repository (ClusterSnapshotRepositoryInfo)
Snapshot repository configuration
repository_name (string)
Deprecated: ECE snapshot repository name, please use [repository] instead
retention (ClusterSnapshotRetention)
Cluster snapshot retention information
suspended (array[string])
List of temporary snapshot suspensions
wait_time_after_snapshotting (string)
The time to wait between snapshot phases (snapshot, purge), with the format 'length unit' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 10 minutes

Example

{
   "enabled" : true,
   "interval" : "string",
   "pending_interval" : "string",
   "repository" : {
      "default" : {},
      "reference" : {
         "repository_name" : "string"
      },
      "static" : {
         "repository_type" : "string",
         "settings" : {}
      }
   },
   "repository_name" : "string",
   "retention" : {
      "max_age" : "string",
      "snapshots" : 0
   },
   "suspended" : [
      "string"
   ],
   "wait_time_after_snapshotting" : "string"
}

ClusterSystemAlert

Information about a system alert on an Elasticsearch cluster.

Properties

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

Example

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

ClusterTopologyInfo

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

Properties

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

Example

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

ClusterUpgradeInfo

Information about an Elasticsearch cluster upgrade.

Properties

cluster_id (string, required)
Cluster id
cluster_version (string, required)
Version that the cluster will be running from now on

Example

{
   "cluster_id" : "string",
   "cluster_version" : "string"
}

ClustersInfo

Information about a set of Elasticsearch clusters, multiple Kibana instance, or multiple APM Servers.

Properties

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

Example

{
   "clusters" : [
      {
         "apm" : {
            "elasticsearch_cluster" : {
               "elasticsearch_id" : "string",
               "links" : {
                  "some_property" : {
                     "need_elevated_permissions" : true
                  }
               }
            },
            "external_links" : [
               {
                  "id" : "string",
                  "label" : "string",
                  "uri" : "string"
               }
            ],
            "healthy" : true,
            "id" : "string",
            "links" : {
               "some_property" : null
            },
            "metadata" : {
               "cloud_id" : "string",
               "endpoint" : "string",
               "last_modified" : "2019-01-01T00:00:00Z",
               "ports" : {
                  "http" : 0,
                  "https" : 0
               },
               "raw" : {},
               "version" : 0
            },
            "name" : "string",
            "plan_info" : {
               "current" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "healthy" : true,
                  "plan" : {
                     "apm" : {
                        "docker_image" : "string",
                        "system_settings" : {
                           "debug_enabled" : "string",
                           "elasticsearch_password" : "string",
                           "elasticsearch_url" : "string",
                           "elasticsearch_username" : "string",
                           "kibana_url" : "string",
                           "secret_token" : "string"
                        },
                        "user_settings_json" : {},
                        "user_settings_override_json" : {},
                        "user_settings_override_yaml" : "string",
                        "user_settings_yaml" : "string",
                        "version" : "string"
                     },
                     "cluster_topology" : [
                        {
                           "apm" : null,
                           "instance_configuration_id" : "string",
                           "size" : {
                              "resource" : "string",
                              "value" : 0
                           },
                           "zone_count" : 0
                        }
                     ],
                     "transient" : {
                        "plan_configuration" : {
                           "calm_wait_time" : 0,
                           "cluster_reboot" : "string",
                           "extended_maintenance" : true,
                           "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" : {
                           "grow_and_shrink" : {},
                           "rolling" : {
                              "allow_inline_resize" : true,
                              "group_by" : "string",
                              "shard_init_wait_time" : 0,
                              "skip_synced_flush" : true
                           },
                           "rolling_grow_and_shrink" : {}
                        }
                     }
                  },
                  "plan_attempt_id" : "string",
                  "plan_attempt_log" : [
                     {
                        "completed" : "2019-01-01T00:00:00Z",
                        "duration_in_millis" : 0,
                        "info_log" : [
                           {
                              "delta_in_millis" : 0,
                              "message" : "string",
                              "stage" : "string",
                              "timestamp" : "2019-01-01T00:00:00Z"
                           }
                        ],
                        "stage" : "string",
                        "started" : "2019-01-01T00:00:00Z",
                        "status" : "string",
                        "step_id" : "string"
                     }
                  ],
                  "plan_attempt_name" : "string",
                  "plan_end_time" : "2019-01-01T00:00:00Z",
                  "source" : {
                     "action" : "string",
                     "admin_id" : "string",
                     "date" : "2019-01-01T00:00:00Z",
                     "facilitator" : "string",
                     "remote_addresses" : [
                        "string"
                     ],
                     "user_id" : "string"
                  }
               },
               "healthy" : true,
               "history" : [
                  null
               ],
               "pending" : null
            },
            "region" : "string",
            "settings" : {
               "metadata" : {
                  "contact_email" : "string",
                  "hidden" : true,
                  "name" : "string",
                  "owner_id" : "string",
                  "resources" : {
                     "cpu" : {
                        "boost" : true,
                        "hard_limit" : true
                     }
                  },
                  "subscription_level" : "string",
                  "system_owned" : true
               }
            },
            "status" : "string",
            "topology" : {
               "healthy" : true,
               "instances" : [
                  {
                     "allocator_id" : "string",
                     "container_started" : true,
                     "disk" : {
                        "disk_space_available" : 0,
                        "disk_space_used" : 0,
                        "storage_multiplier" : 0.1
                     },
                     "healthy" : true,
                     "instance_configuration" : {
                        "id" : "string",
                        "name" : "string",
                        "resource" : "string"
                     },
                     "instance_name" : "string",
                     "maintenance_mode" : true,
                     "memory" : {
                        "instance_capacity" : 0,
                        "instance_capacity_planned" : 0,
                        "memory_pressure" : 0,
                        "native_memory_pressure" : 0
                     },
                     "service_id" : "string",
                     "service_roles" : [
                        "string"
                     ],
                     "service_running" : true,
                     "service_version" : "string",
                     "zone" : "string"
                  }
               ]
            }
         },
         "elasticsearch" : {
            "associated_apm_clusters" : [
               {
                  "apm_id" : "string",
                  "enabled" : true,
                  "links" : {
                     "some_property" : null
                  }
               }
            ],
            "associated_kibana_clusters" : [
               {
                  "enabled" : true,
                  "kibana_id" : "string",
                  "links" : {
                     "some_property" : null
                  }
               }
            ],
            "ccs" : {
               "healthy" : true,
               "remote_clusters" : [
                  {
                     "compatible" : true,
                     "id" : "string",
                     "version" : "string"
                  }
               ]
            },
            "cluster_id" : "string",
            "cluster_name" : "string",
            "elasticsearch" : {
               "blocking_issues" : {
                  "cluster_level" : [
                     {
                        "description" : "string",
                        "instances" : [
                           "string"
                        ]
                     }
                  ],
                  "healthy" : true,
                  "index_level" : [
                     null
                  ]
               },
               "healthy" : true,
               "master_info" : {
                  "healthy" : true,
                  "instances_with_no_master" : [
                     "string"
                  ],
                  "masters" : [
                     {
                        "instances" : [
                           "string"
                        ],
                        "master_instance_name" : "string",
                        "master_node_id" : "string"
                     }
                  ]
               },
               "shard_info" : {
                  "available_shards" : [
                     {
                        "instance_name" : "string",
                        "shard_count" : 0
                     }
                  ],
                  "healthy" : true,
                  "unavailable_replicas" : [
                     {
                        "instance_name" : "string",
                        "replica_count" : 0
                     }
                  ],
                  "unavailable_shards" : [
                     null
                  ]
               }
            },
            "elasticsearch_monitoring_info" : {
               "destination_cluster_ids" : [
                  "string"
               ],
               "healthy" : true,
               "last_modified" : "2019-01-01T00:00:00Z",
               "last_update_status" : "string",
               "source_cluster_ids" : [
                  "string"
               ]
            },
            "external_links" : [
               null
            ],
            "healthy" : true,
            "links" : {
               "some_property" : null
            },
            "locked" : true,
            "metadata" : null,
            "plan_info" : {
               "current" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "healthy" : true,
                  "plan" : {
                     "cluster_topology" : [
                        {
                           "allocator_filter" : {},
                           "elasticsearch" : {
                              "curation" : {
                                 "from_instance_configuration_id" : "string",
                                 "to_instance_configuration_id" : "string"
                              },
                              "docker_image" : "string",
                              "enabled_built_in_plugins" : [
                                 "string"
                              ],
                              "node_attributes" : {
                                 "some_property" : "string"
                              },
                              "system_settings" : {
                                 "auto_create_index" : true,
                                 "default_shards_per_index" : 0,
                                 "destructive_requires_name" : true,
                                 "enable_close_index" : true,
                                 "monitoring_collection_interval" : 0,
                                 "monitoring_history_duration" : "string",
                                 "reindex_whitelist" : [
                                    "string"
                                 ],
                                 "scripting" : {
                                    "expressions_enabled" : true,
                                    "file" : {
                                       "enabled" : true,
                                       "sandbox_mode" : true
                                    },
                                    "inline" : null,
                                    "mustache_enabled" : true,
                                    "painless_enabled" : true,
                                    "stored" : null
                                 },
                                 "use_disk_threshold" : true,
                                 "watcher_trigger_engine" : "string"
                              },
                              "user_bundles" : [
                                 {
                                    "elasticsearch_version" : "string",
                                    "name" : "string",
                                    "url" : "string"
                                 }
                              ],
                              "user_plugins" : [
                                 {
                                    "elasticsearch_version" : "string",
                                    "name" : "string",
                                    "url" : "string"
                                 }
                              ],
                              "user_settings_json" : {},
                              "user_settings_override_json" : {},
                              "user_settings_override_yaml" : "string",
                              "user_settings_yaml" : "string",
                              "version" : "string"
                           },
                           "instance_configuration_id" : "string",
                           "memory_per_node" : 0,
                           "node_configuration" : "string",
                           "node_count_per_zone" : 0,
                           "node_type" : {
                              "data" : true,
                              "ingest" : true,
                              "master" : true,
                              "ml" : true
                           },
                           "size" : null,
                           "zone_count" : 0
                        }
                     ],
                     "deployment_template" : {
                        "id" : "string",
                        "version" : "string"
                     },
                     "elasticsearch" : null,
                     "tiebreaker_override" : true,
                     "tiebreaker_topology" : {
                        "memory_per_node" : 0
                     },
                     "transient" : {
                        "cluster_settings_json" : {},
                        "plan_configuration" : {
                           "calm_wait_time" : 0,
                           "cluster_reboot" : "string",
                           "extended_maintenance" : true,
                           "max_snapshot_age" : 0,
                           "max_snapshot_attempts" : 0,
                           "move_allocators" : [
                              null
                           ],
                           "move_instances" : [
                              null
                           ],
                           "move_only" : true,
                           "override_failsafe" : true,
                           "preferred_allocators" : [
                              "string"
                           ],
                           "reallocate_instances" : true,
                           "skip_data_migration" : true,
                           "skip_post_upgrade_steps" : true,
                           "skip_snapshot" : true,
                           "skip_upgrade_checker" : true,
                           "timeout" : 0
                        },
                        "restore_snapshot" : {
                           "repository_config" : {
                              "raw_settings" : {}
                           },
                           "repository_name" : "string",
                           "restore_payload" : {
                              "indices" : [
                                 "string"
                              ],
                              "raw_settings" : {}
                           },
                           "snapshot_name" : "string",
                           "source_cluster_id" : "string",
                           "strategy" : "string"
                        },
                        "strategy" : null
                     },
                     "zone_count" : 0
                  },
                  "plan_attempt_id" : "string",
                  "plan_attempt_log" : [
                     null
                  ],
                  "plan_attempt_name" : "string",
                  "plan_end_time" : "2019-01-01T00:00:00Z",
                  "source" : null
               },
               "healthy" : true,
               "history" : [
                  null
               ],
               "pending" : null
            },
            "region" : "string",
            "security" : {
               "last_modified" : "2019-01-01T00:00:00Z",
               "roles" : {},
               "users" : [
                  {
                     "password_hash" : "string",
                     "username" : "string"
                  }
               ],
               "users_roles" : [
                  {
                     "roles" : [
                        "string"
                     ],
                     "username" : "string"
                  }
               ],
               "version" : 0
            },
            "settings" : {
               "ccs" : {
                  "remote_clusters" : {
                     "some_property" : {
                        "cluster_id" : "string",
                        "skip_unavailable" : true
                     }
                  }
               },
               "curation" : {
                  "specs" : [
                     {
                        "index_pattern" : "string",
                        "trigger_interval_seconds" : 0
                     }
                  ]
               },
               "dedicated_masters_threshold" : 0,
               "ip_filtering" : {
                  "rulesets" : [
                     "string"
                  ]
               },
               "metadata" : null,
               "monitoring" : {
                  "target_cluster_id" : "string"
               },
               "snapshot" : {
                  "enabled" : true,
                  "interval" : "string",
                  "pending_interval" : "string",
                  "repository" : {
                     "default" : {},
                     "reference" : {
                        "repository_name" : "string"
                     },
                     "static" : {
                        "repository_type" : "string",
                        "settings" : {}
                     }
                  },
                  "repository_name" : "string",
                  "retention" : {
                     "max_age" : "string",
                     "snapshots" : 0
                  },
                  "suspended" : [
                     "string"
                  ],
                  "wait_time_after_snapshotting" : "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",
                  "instance_name" : "string",
                  "timestamp" : "2019-01-01T00:00:00Z",
                  "url" : "string"
               }
            ],
            "topology" : null
         },
         "kibana" : {
            "cluster_id" : "string",
            "cluster_name" : "string",
            "elasticsearch_cluster" : null,
            "external_links" : [
               null
            ],
            "healthy" : true,
            "links" : {
               "some_property" : null
            },
            "metadata" : null,
            "plan_info" : {
               "current" : {
                  "attempt_end_time" : "2019-01-01T00:00:00Z",
                  "attempt_start_time" : "2019-01-01T00:00:00Z",
                  "healthy" : true,
                  "plan" : {
                     "cluster_topology" : [
                        {
                           "allocator_filter" : {},
                           "instance_configuration_id" : "string",
                           "kibana" : {
                              "docker_image" : "string",
                              "system_settings" : {
                                 "elasticsearch_password" : "string",
                                 "elasticsearch_url" : "string",
                                 "elasticsearch_username" : "string"
                              },
                              "user_settings_json" : {},
                              "user_settings_override_json" : {},
                              "user_settings_override_yaml" : "string",
                              "user_settings_yaml" : "string",
                              "version" : "string"
                           },
                           "memory_per_node" : 0,
                           "node_configuration" : "string",
                           "node_count_per_zone" : 0,
                           "size" : null,
                           "zone_count" : 0
                        }
                     ],
                     "kibana" : null,
                     "transient" : {
                        "plan_configuration" : {
                           "calm_wait_time" : 0,
                           "cluster_reboot" : "string",
                           "extended_maintenance" : true,
                           "move_allocators" : [
                              null
                           ],
                           "move_instances" : [
                              null
                           ],
                           "preferred_allocators" : [
                              "string"
                           ],
                           "reallocate_instances" : true,
                           "timeout" : 0
                        },
                        "strategy" : null
                     },
                     "zone_count" : 0
                  },
                  "plan_attempt_id" : "string",
                  "plan_attempt_log" : [
                     null
                  ],
                  "plan_attempt_name" : "string",
                  "plan_end_time" : "2019-01-01T00:00:00Z",
                  "source" : null
               },
               "healthy" : true,
               "history" : [
                  null
               ],
               "pending" : null
            },
            "region" : "string",
            "settings" : {
               "metadata" : null
            },
            "status" : "string",
            "topology" : null
         }
      }
   ],
   "match_count" : 0,
   "return_count" : 0
}

CompatibleNodeTypesResource

Information about the compatible node types.

Properties

capacity_constraints (CapacityConstraintsResource)
Capacity constraints for the node type
compatible_node_types (array[string], required)
Compatible node types for the this node type
node_type (string, required)
Type of this node

Example

{
   "capacity_constraints" : {
      "max" : 0,
      "min" : 0
   },
   "compatible_node_types" : [
      "string"
   ],
   "node_type" : "string"
}

CompatibleVersionResource

Information about the compatible version.

Properties

capacity_constraints (CapacityConstraintsResource)
Capacity constraints for the version
node_types (array[CompatibleNodeTypesResource], required)
Supported node types for the version
version (string, required)
Compatible version, the key for this resource

Example

{
   "capacity_constraints" : {
      "max" : 0,
      "min" : 0
   },
   "node_types" : [
      {
         "capacity_constraints" : null,
         "compatible_node_types" : [
            "string"
         ],
         "node_type" : "string"
      }
   ],
   "version" : "string"
}

ConfigStoreOption

Information about the Config Store options.

Properties

changed (boolean, required)
Whether or not this Config Store Option has changed
name (string, required)
Name of this Config Store Option
value (string, required)
Value of this Config Store Option

Example

{
   "changed" : true,
   "name" : "string",
   "value" : "string"
}

ConfigStoreOptionData

The data for the Config Store options.

Properties

value (string, required)
Value of this Config Store Option

Example

{
   "value" : "string"
}

ConfigStoreOptionList

A list of Config Store values.

Properties

values (array[ConfigStoreOption], required)
List of Config Store Options

Example

{
   "values" : [
      {
         "changed" : true,
         "name" : "string",
         "value" : "string"
      }
   ]
}

ConstructorHealthStatus

The health status of the constructor.

Properties

connected (boolean)
Whether the constructor is connected
maintenance_mode (boolean)
Whether the constructor is in maintenance mode

Example

{
   "connected" : true,
   "maintenance_mode" : true
}

ConstructorInfo

Information about the constructor.

Properties

constructor_id (string)
Identifier for this constructor
status (ConstructorHealthStatus)
The health status of the constructor.

Example

{
   "constructor_id" : "string",
   "status" : {
      "connected" : true,
      "maintenance_mode" : true
   }
}

ConstructorOverview

The overview information for the installed constructors.

Properties

constructors (array[ConstructorInfo])

Example

{
   "constructors" : [
      {
         "constructor_id" : "string",
         "status" : {
            "connected" : true,
            "maintenance_mode" : true
         }
      }
   ]
}

CreateApmInCreateElasticsearchRequest

The request body for creating an APM Server, which is included in the Elasticsearch cluster create request.

Properties

name (string)
The human readable name for the Apm cluster (default: takes the name of its Elasticsearch cluster)
plan (ApmPlan, required)
The plan for the APM Server.

Example

{
   "name" : "string",
   "plan" : {
      "apm" : {
         "docker_image" : "string",
         "system_settings" : {
            "debug_enabled" : "string",
            "elasticsearch_password" : "string",
            "elasticsearch_url" : "string",
            "elasticsearch_username" : "string",
            "kibana_url" : "string",
            "secret_token" : "string"
         },
         "user_settings_json" : {},
         "user_settings_override_json" : {},
         "user_settings_override_yaml" : "string",
         "user_settings_yaml" : "string",
         "version" : "string"
      },
      "cluster_topology" : [
         {
            "apm" : null,
            "instance_configuration_id" : "string",
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "transient" : {
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "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" : {
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   }
}

CreateApmRequest

The request body for creating one or more APM Servers.

Properties

display_name (string)
The human readable name for the APM cluster (default: takes the name of its Elasticsearch cluster)
elasticsearch_cluster_id (string, required)
The Id of the Elasticsearch cluster to which this APM will be connected
plan (ApmPlan, required)
The plan for the APM Server.

Example

{
   "display_name" : "string",
   "elasticsearch_cluster_id" : "string",
   "plan" : {
      "apm" : {
         "docker_image" : "string",
         "system_settings" : {
            "debug_enabled" : "string",
            "elasticsearch_password" : "string",
            "elasticsearch_url" : "string",
            "elasticsearch_username" : "string",
            "kibana_url" : "string",
            "secret_token" : "string"
         },
         "user_settings_json" : {},
         "user_settings_override_json" : {},
         "user_settings_override_yaml" : "string",
         "user_settings_yaml" : "string",
         "version" : "string"
      },
      "cluster_topology" : [
         {
            "apm" : null,
            "instance_configuration_id" : "string",
            "size" : {
               "resource" : "string",
               "value" : 0
            },
            "zone_count" : 0
         }
      ],
      "transient" : {
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "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" : {
            "grow_and_shrink" : {},
            "rolling" : {
               "allow_inline_resize" : true,
               "group_by" : "string",
               "shard_init_wait_time" : 0,
               "skip_synced_flush" : true
            },
            "rolling_grow_and_shrink" : {}
         }
      }
   }
}

CreateElasticsearchClusterRequest

The request body for creating an Elasticsearch cluster.

Properties

apm (CreateApmInCreateElasticsearchRequest)
The request body for creating an APM Server, which is included in the Elasticsearch cluster create request.
cluster_name (string)
The human readable name for the cluster (defaults to the generated cluster id if not specified)
kibana (CreateKibanaInCreateElasticsearchRequest)
The request body for creating a Kibana instance, which is included in the Elasticsearch cluster create request.
plan (ElasticsearchClusterPlan, required)
The plan for the Elasticsearch cluster.
settings (ElasticsearchClusterSettings)
The settings for an Elasticsearch cluster.

Example

{
   "apm" : {
      "name" : "string",
      "plan" : {
         "apm" : {
            "docker_image" : "string",
            "system_settings" : {
               "debug_enabled" : "string",
               "elasticsearch_password" : "string",
               "elasticsearch_url" : "string",
               "elasticsearch_username" : "string",
               "kibana_url" : "string",
               "secret_token" : "string"
            },
            "user_settings_json" : {},
            "user_settings_override_json" : {},
            "user_settings_override_yaml" : "string",
            "user_settings_yaml" : "string",
            "version" : "string"
         },
         "cluster_topology" : [
            {
               "apm" : null,
               "instance_configuration_id" : "string",
               "size" : {
                  "resource" : "string",
                  "value" : 0
               },
               "zone_count" : 0
            }
         ],
         "transient" : {
            "plan_configuration" : {
               "calm_wait_time" : 0,
               "cluster_reboot" : "string",
               "extended_maintenance" : true,
               "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" : {
               "grow_and_shrink" : {},
               "rolling" : {
                  "allow_inline_resize" : true,
                  "group_by" : "string",
                  "shard_init_wait_time" : 0,
                  "skip_synced_flush" : true
               },
               "rolling_grow_and_shrink" : {}
            }
         }
      }
   },
   "cluster_name" : "string",
   "kibana" : {
      "cluster_name" : "string",
      "plan" : {
         "cluster_topology" : [
            {
               "allocator_filter" : {},
               "instance_configuration_id" : "string",
               "kibana" : {
                  "docker_image" : "string",
                  "system_settings" : {
                     "elasticsearch_password" : "string",
                     "elasticsearch_url" : "string",
                     "elasticsearch_username" : "string"
                  },
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "memory_per_node" : 0,
               "node_configuration" : "string",
               "node_count_per_zone" : 0,
               "size" : null,
               "zone_count" : 0
            }
         ],
         "kibana" : null,
         "transient" : {
            "plan_configuration" : {
               "calm_wait_time" : 0,
               "cluster_reboot" : "string",
               "extended_maintenance" : true,
               "move_allocators" : [
                  null
               ],
               "move_instances" : [
                  null
               ],
               "preferred_allocators" : [
                  "string"
               ],
               "reallocate_instances" : true,
               "timeout" : 0
            },
            "strategy" : null
         },
         "zone_count" : 0
      }
   },
   "plan" : {
      "cluster_topology" : [
         {
            "allocator_filter" : {},
            "elasticsearch" : {
               "curation" : {
                  "from_instance_configuration_id" : "string",
                  "to_instance_configuration_id" : "string"
               },
               "docker_image" : "string",
               "enabled_built_in_plugins" : [
                  "string"
               ],
               "node_attributes" : {
                  "some_property" : "string"
               },
               "system_settings" : {
                  "auto_create_index" : true,
                  "default_shards_per_index" : 0,
                  "destructive_requires_name" : true,
                  "enable_close_index" : true,
                  "monitoring_collection_interval" : 0,
                  "monitoring_history_duration" : "string",
                  "reindex_whitelist" : [
                     "string"
                  ],
                  "scripting" : {
                     "expressions_enabled" : true,
                     "file" : {
                        "enabled" : true,
                        "sandbox_mode" : true
                     },
                     "inline" : null,
                     "mustache_enabled" : true,
                     "painless_enabled" : true,
                     "stored" : null
                  },
                  "use_disk_threshold" : true,
                  "watcher_trigger_engine" : "string"
               },
               "user_bundles" : [
                  {
                     "elasticsearch_version" : "string",
                     "name" : "string",
                     "url" : "string"
                  }
               ],
               "user_plugins" : [
                  {
                     "elasticsearch_version" : "string",
                     "name" : "string",
                     "url" : "string"
                  }
               ],
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "instance_configuration_id" : "string",
            "memory_per_node" : 0,
            "node_configuration" : "string",
            "node_count_per_zone" : 0,
            "node_type" : {
               "data" : true,
               "ingest" : true,
               "master" : true,
               "ml" : true
            },
            "size" : null,
            "zone_count" : 0
         }
      ],
      "deployment_template" : {
         "id" : "string",
         "version" : "string"
      },
      "elasticsearch" : null,
      "tiebreaker_override" : true,
      "tiebreaker_topology" : {
         "memory_per_node" : 0
      },
      "transient" : {
         "cluster_settings_json" : {},
         "plan_configuration" : {
            "calm_wait_time" : 0,
            "cluster_reboot" : "string",
            "extended_maintenance" : true,
            "max_snapshot_age" : 0,
            "max_snapshot_attempts" : 0,
            "move_allocators" : [
               null
            ],
            "move_instances" : [
               null
            ],
            "move_only" : true,
            "override_failsafe" : true,
            "preferred_allocators" : [
               "string"
            ],
            "reallocate_instances" : true,
            "skip_data_migration" : true,
            "skip_post_upgrade_steps" : true,
            "skip_snapshot" : true,
            "skip_upgrade_checker" : true,
            "timeout" : 0
         },
         "restore_snapshot" : {
            "repository_config" : {
               "raw_settings" : {}
            },
            "repository_name" : "string",
            "restore_payload" : {
               "indices" : [
                  "string"
               ],
               "raw_settings" : {}
            },
            "snapshot_name" : "string",
            "source_cluster_id" : "string",
            "strategy" : "string"
         },
         "strategy" : null
      },
      "zone_count" : 0
   },
   "settings" : {
      "ccs" : {
         "remote_clusters" : {
            "some_property" : {
               "cluster_id" : "string",
               "skip_unavailable" : true
            }
         }
      },
      "curation" : {
         "specs" : [
            {
               "index_pattern" : "string",
               "trigger_interval_seconds" : 0
            }
         ]
      },
      "dedicated_masters_threshold" : 0,
      "ip_filtering" : {
         "rulesets" : [
            "string"
         ]
      },
      "metadata" : {
         "contact_email" : "string",
         "hidden" : true,
         "name" : "string",
         "owner_id" : "string",
         "resources" : {
            "cpu" : {
               "boost" : true,
               "hard_limit" : true
            }
         },
         "subscription_level" : "string",
         "system_owned" : true
      },
      "monitoring" : {
         "target_cluster_id" : "string"
      },
      "snapshot" : {
         "enabled" : true,
         "interval" : "string",
         "pending_interval" : "string",
         "repository" : {
            "default" : {},
            "reference" : {
               "repository_name" : "string"
            },
            "static" : {
               "repository_type" : "string",
               "settings" : {}
            }
         },
         "repository_name" : "string",
         "retention" : {
            "max_age" : "string",
            "snapshots" : 0
         },
         "suspended" : [
            "string"
         ],
         "wait_time_after_snapshotting" : "string"
      }
   }
}

CreateKibanaInCreateElasticsearchRequest

The request body for creating a Kibana instance, which is included in the Elasticsearch cluster create request.

Properties

cluster_name (string)
The human readable name for the Kibana cluster (default: takes the name of its Elasticsearch cluster)
plan (KibanaClusterPlan, required)
The plan for the Kibana instance.

Example

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

CreateKibanaRequest

The request body for creating one or more Kibana instances.

Properties

cluster_name (string)
The human readable name for the Kibana cluster (default: takes the name of its Elasticsearch cluster)
elasticsearch_cluster_id (string, required)
The Id of the Elasticsearch cluster to which this Kibana will be connected
plan (KibanaClusterPlan, required)
The plan for the Kibana instance.

Example

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

CrossClusterSearchClusters

The cross-cluster search clusters for the remote clusters.

Properties

ccs_clusters (array[string], required)
Cross-cluster search clusers' IDs for the remote cluster

Example

{
   "ccs_clusters" : [
      "string"
   ]
}

CrossClusterSearchInfo

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

Properties

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

Example

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

CrossClusterSearchSettings

The configuration settings for the cross-cluster search.

Properties

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

Example

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

DeploymentTemplateInfo

The top-level object for a deployment template.

Properties

cluster_template (CreateElasticsearchClusterRequest)
The body of the cluster template to use for creating a cluster.
description (string)
An optional description for the template.
hidden (boolean)
Whether or not the deployment template is hidden by default.
id (string)
The unique identifier for the template.
instance_configurations (array[InstanceConfiguration])
Optional list of instance configurations used in the cluster template.
metadata (array[MetadataItem])
Optional arbitrary metadata to associate with this template.
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.

Example

{
   "cluster_template" : {
      "apm" : {
         "name" : "string",
         "plan" : {
            "apm" : {
               "docker_image" : "string",
               "system_settings" : {
                  "debug_enabled" : "string",
                  "elasticsearch_password" : "string",
                  "elasticsearch_url" : "string",
                  "elasticsearch_username" : "string",
                  "kibana_url" : "string",
                  "secret_token" : "string"
               },
               "user_settings_json" : {},
               "user_settings_override_json" : {},
               "user_settings_override_yaml" : "string",
               "user_settings_yaml" : "string",
               "version" : "string"
            },
            "cluster_topology" : [
               {
                  "apm" : null,
                  "instance_configuration_id" : "string",
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "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" : {
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            }
         }
      },
      "cluster_name" : "string",
      "kibana" : {
         "cluster_name" : "string",
         "plan" : {
            "cluster_topology" : [
               {
                  "allocator_filter" : {},
                  "instance_configuration_id" : "string",
                  "kibana" : {
                     "docker_image" : "string",
                     "system_settings" : {
                        "elasticsearch_password" : "string",
                        "elasticsearch_url" : "string",
                        "elasticsearch_username" : "string"
                     },
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "memory_per_node" : 0,
                  "node_configuration" : "string",
                  "node_count_per_zone" : 0,
                  "size" : null,
                  "zone_count" : 0
               }
            ],
            "kibana" : null,
            "transient" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "move_allocators" : [
                     null
                  ],
                  "move_instances" : [
                     null
                  ],
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "timeout" : 0
               },
               "strategy" : null
            },
            "zone_count" : 0
         }
      },
      "plan" : {
         "cluster_topology" : [
            {
               "allocator_filter" : {},
               "elasticsearch" : {
                  "curation" : {
                     "from_instance_configuration_id" : "string",
                     "to_instance_configuration_id" : "string"
                  },
                  "docker_image" : "string",
                  "enabled_built_in_plugins" : [
                     "string"
                  ],
                  "node_attributes" : {
                     "some_property" : "string"
                  },
                  "system_settings" : {
                     "auto_create_index" : true,
                     "default_shards_per_index" : 0,
                     "destructive_requires_name" : true,
                     "enable_close_index" : true,
                     "monitoring_collection_interval" : 0,
                     "monitoring_history_duration" : "string",
                     "reindex_whitelist" : [
                        "string"
                     ],
                     "scripting" : {
                        "expressions_enabled" : true,
                        "file" : {
                           "enabled" : true,
                           "sandbox_mode" : true
                        },
                        "inline" : null,
                        "mustache_enabled" : true,
                        "painless_enabled" : true,
                        "stored" : null
                     },
                     "use_disk_threshold" : true,
                     "watcher_trigger_engine" : "string"
                  },
                  "user_bundles" : [
                     {
                        "elasticsearch_version" : "string",
                        "name" : "string",
                        "url" : "string"
                     }
                  ],
                  "user_plugins" : [
                     {
                        "elasticsearch_version" : "string",
                        "name" : "string",
                        "url" : "string"
                     }
                  ],
                  "user_settings_json" : {},
                  "user_settings_override_json" : {},
                  "user_settings_override_yaml" : "string",
                  "user_settings_yaml" : "string",
                  "version" : "string"
               },
               "instance_configuration_id" : "string",
               "memory_per_node" : 0,
               "node_configuration" : "string",
               "node_count_per_zone" : 0,
               "node_type" : {
                  "data" : true,
                  "ingest" : true,
                  "master" : true,
                  "ml" : true
               },
               "size" : null,
               "zone_count" : 0
            }
         ],
         "deployment_template" : {
            "id" : "string",
            "version" : "string"
         },
         "elasticsearch" : null,
         "tiebreaker_override" : true,
         "tiebreaker_topology" : {
            "memory_per_node" : 0
         },
         "transient" : {
            "cluster_settings_json" : {},
            "plan_configuration" : {
               "calm_wait_time" : 0,
               "cluster_reboot" : "string",
               "extended_maintenance" : true,
               "max_snapshot_age" : 0,
               "max_snapshot_attempts" : 0,
               "move_allocators" : [
                  null
               ],
               "move_instances" : [
                  null
               ],
               "move_only" : true,
               "override_failsafe" : true,
               "preferred_allocators" : [
                  "string"
               ],
               "reallocate_instances" : true,
               "skip_data_migration" : true,
               "skip_post_upgrade_steps" : true,
               "skip_snapshot" : true,
               "skip_upgrade_checker" : true,
               "timeout" : 0
            },
            "restore_snapshot" : {
               "repository_config" : {
                  "raw_settings" : {}
               },
               "repository_name" : "string",
               "restore_payload" : {
                  "indices" : [
                     "string"
                  ],
                  "raw_settings" : {}
               },
               "snapshot_name" : "string",
               "source_cluster_id" : "string",
               "strategy" : "string"
            },
            "strategy" : null
         },
         "zone_count" : 0
      },
      "settings" : {
         "ccs" : {
            "remote_clusters" : {
               "some_property" : {
                  "cluster_id" : "string",
                  "skip_unavailable" : true
               }
            }
         },
         "curation" : {
            "specs" : [
               {
                  "index_pattern" : "string",
                  "trigger_interval_seconds" : 0
               }
            ]
         },
         "dedicated_masters_threshold" : 0,
         "ip_filtering" : {
            "rulesets" : [
               "string"
            ]
         },
         "metadata" : {
            "contact_email" : "string",
            "hidden" : true,
            "name" : "string",
            "owner_id" : "string",
            "resources" : {
               "cpu" : {
                  "boost" : true,
                  "hard_limit" : true
               }
            },
            "subscription_level" : "string",
            "system_owned" : true
         },
         "monitoring" : {
            "target_cluster_id" : "string"
         },
         "snapshot" : {
            "enabled" : true,
            "interval" : "string",
            "pending_interval" : "string",
            "repository" : {
               "default" : {},
               "reference" : {
                  "repository_name" : "string"
               },
               "static" : {
                  "repository_type" : "string",
                  "settings" : {}
               }
            },
            "repository_name" : "string",
            "retention" : {
               "max_age" : "string",
               "snapshots" : 0
            },
            "suspended" : [
               "string"
            ],
            "wait_time_after_snapshotting" : "string"
         }
      }
   },
   "description" : "string",
   "hidden" : true,
   "id" : "string",
   "instance_configurations" : [
      {
         "allocator_filter" : {
            "bool" : {
               "filter" : [
                  null
               ],
               "minimum_should_match" : 0,
               "must" : [
                  null
               ],
               "must_not" : [
                  null
               ],
               "should" : [
                  null
               ]
            },
            "exists" : {
               "field" : "string"
            },
            "match" : {
               "some_property" : {
                  "analyzer" : "string",
                  "minimum_should_match" : 0,
                  "operator" : "string",
                  "query" : "string"
               }
            },
            "match_all" : {},
            "match_none" : {},
            "nested" : {
               "path" : "string",
               "query" : null,
               "score_mode" : "string"
            },
            "prefix" : {
               "some_property" : {
                  "boost" : 0.1,
                  "value" : "string"
               }
            },
            "query_string" : {
               "allow_leading_wildcard" : true,
               "analyzer" : "string",
               "default_field" : "string",
               "default_operator" : "string",
               "query" : "string"
            },
            "range" : {
               "some_property" : {
                  "boost" : 0.1,
                  "format" : "string",
                  "gt" : {},
                  "gte" : {},
                  "lt" : {},
                  "lte" : {},
                  "time_zone" : "string"
               }
            },
            "term" : {
               "some_property" : {
                  "value" : {}
               }
            }
         },
         "deleted_on" : "2019-01-01T00:00:00Z",
         "description" : "string",
         "discrete_sizes" : {
            "default_size" : 0,
            "resource" : "string",
            "sizes" : [
               0
            ]
         },
         "id" : "string",
         "instance_type" : "string",
         "metadata" : {},
         "name" : "string",
         "node_types" : [
            "string"
         ],
         "storage_multiplier" : 0.1,
         "system_owned" : true
      }
   ],
   "metadata" : [
      {
         "key" : "string",
         "value" : "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
}

DeploymentTemplateReference

Specifies the deployment template used to create the plan.

Properties

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

Example

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

DiscreteSizes

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

Properties

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

Example

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

ElasticsearchClusterBlockingIssueElement

Information about an issue and the Elasticsearch instance it affects.

Properties

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

Example

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

ElasticsearchClusterBlockingIssues

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

Properties

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

Example

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

ElasticsearchClusterInfo

The information for an Elasticsearch cluster.

Properties

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

Example

{
   "associated_apm_clusters" : [
      {
         "apm_id" : "string",
         "enabled" : true,
         "links" : {
            "some_property" : {
               "need_elevated_permissions" : true
            }
         }
      }
   ],
   "associated_kibana_clusters" : [
      {
         "enabled" : true,
         "kibana_id" : "string",
         "links" : {
            "some_property" : null
         }
      }
   ],
   "ccs" : {
      "healthy" : true,
      "remote_clusters" : [
         {
            "compatible" : true,
            "id" : "string",
            "version" : "string"
         }
      ]
   },
   "cluster_id" : "string",
   "cluster_name" : "string",
   "elasticsearch" : {
      "blocking_issues" : {
         "cluster_level" : [
            {
               "description" : "string",
               "instances" : [
                  "string"
               ]
            }
         ],
         "healthy" : true,
         "index_level" : [
            null
         ]
      },
      "healthy" : true,
      "master_info" : {
         "healthy" : true,
         "instances_with_no_master" : [
            "string"
         ],
         "masters" : [
            {
               "instances" : [
                  "string"
               ],
               "master_instance_name" : "string",
               "master_node_id" : "string"
            }
         ]
      },
      "shard_info" : {
         "available_shards" : [
            {
               "instance_name" : "string",
               "shard_count" : 0
            }
         ],
         "healthy" : true,
         "unavailable_replicas" : [
            {
               "instance_name" : "string",
               "replica_count" : 0
            }
         ],
         "unavailable_shards" : [
            null
         ]
      }
   },
   "elasticsearch_monitoring_info" : {
      "destination_cluster_ids" : [
         "string"
      ],
      "healthy" : true,
      "last_modified" : "2019-01-01T00:00:00Z",
      "last_update_status" : "string",
      "source_cluster_ids" : [
         "string"
      ]
   },
   "external_links" : [
      {
         "id" : "string",
         "label" : "string",
         "uri" : "string"
      }
   ],
   "healthy" : true,
   "links" : {
      "some_property" : null
   },
   "locked" : true,
   "metadata" : {
      "cloud_id" : "string",
      "endpoint" : "string",
      "last_modified" : "2019-01-01T00:00:00Z",
      "ports" : {
         "http" : 0,
         "https" : 0
      },
      "raw" : {},
      "version" : 0
   },
   "plan_info" : {
      "current" : {
         "attempt_end_time" : "2019-01-01T00:00:00Z",
         "attempt_start_time" : "2019-01-01T00:00:00Z",
         "healthy" : true,
         "plan" : {
            "cluster_topology" : [
               {
                  "allocator_filter" : {},
                  "elasticsearch" : {
                     "curation" : {
                        "from_instance_configuration_id" : "string",
                        "to_instance_configuration_id" : "string"
                     },
                     "docker_image" : "string",
                     "enabled_built_in_plugins" : [
                        "string"
                     ],
                     "node_attributes" : {
                        "some_property" : "string"
                     },
                     "system_settings" : {
                        "auto_create_index" : true,
                        "default_shards_per_index" : 0,
                        "destructive_requires_name" : true,
                        "enable_close_index" : true,
                        "monitoring_collection_interval" : 0,
                        "monitoring_history_duration" : "string",
                        "reindex_whitelist" : [
                           "string"
                        ],
                        "scripting" : {
                           "expressions_enabled" : true,
                           "file" : {
                              "enabled" : true,
                              "sandbox_mode" : true
                           },
                           "inline" : null,
                           "mustache_enabled" : true,
                           "painless_enabled" : true,
                           "stored" : null
                        },
                        "use_disk_threshold" : true,
                        "watcher_trigger_engine" : "string"
                     },
                     "user_bundles" : [
                        {
                           "elasticsearch_version" : "string",
                           "name" : "string",
                           "url" : "string"
                        }
                     ],
                     "user_plugins" : [
                        {
                           "elasticsearch_version" : "string",
                           "name" : "string",
                           "url" : "string"
                        }
                     ],
                     "user_settings_json" : {},
                     "user_settings_override_json" : {},
                     "user_settings_override_yaml" : "string",
                     "user_settings_yaml" : "string",
                     "version" : "string"
                  },
                  "instance_configuration_id" : "string",
                  "memory_per_node" : 0,
                  "node_configuration" : "string",
                  "node_count_per_zone" : 0,
                  "node_type" : {
                     "data" : true,
                     "ingest" : true,
                     "master" : true,
                     "ml" : true
                  },
                  "size" : {
                     "resource" : "string",
                     "value" : 0
                  },
                  "zone_count" : 0
               }
            ],
            "deployment_template" : {
               "id" : "string",
               "version" : "string"
            },
            "elasticsearch" : null,
            "tiebreaker_override" : true,
            "tiebreaker_topology" : {
               "memory_per_node" : 0
            },
            "transient" : {
               "cluster_settings_json" : {},
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "max_snapshot_age" : 0,
                  "max_snapshot_attempts" : 0,
                  "move_allocators" : [
                     {
                        "allocator_down" : true,
                        "from" : "string",
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "move_instances" : [
                     {
                        "from" : "string",
                        "instance_down" : true,
                        "to" : [
                           "string"
                        ]
                     }
                  ],
                  "move_only" : true,
                  "override_failsafe" : true,
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "skip_data_migration" : true,
                  "skip_post_upgrade_steps" : true,
                  "skip_snapshot" : true,
                  "skip_upgrade_checker" : true,
                  "timeout" : 0
               },
               "restore_snapshot" : {
                  "repository_config" : {
                     "raw_settings" : {}
                  },
                  "repository_name" : "string",
                  "restore_payload" : {
                     "indices" : [
                        "string"
                     ],
                     "raw_settings" : {}
                  },
                  "snapshot_name" : "string",
                  "source_cluster_id" : "string",
                  "strategy" : "string"
               },
               "strategy" : {
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            },
            "zone_count" : 0
         },
         "plan_attempt_id" : "string",
         "plan_attempt_log" : [
            {
               "completed" : "2019-01-01T00:00:00Z",
               "duration_in_millis" : 0,
               "info_log" : [
                  {
                     "delta_in_millis" : 0,
                     "message" : "string",
                     "stage" : "string",
                     "timestamp" : "2019-01-01T00:00:00Z"
                  }
               ],
               "stage" : "string",
               "started" : "2019-01-01T00:00:00Z",
               "status" : "string",
               "step_id" : "string"
            }
         ],
         "plan_attempt_name" : "string",
         "plan_end_time" : "2019-01-01T00:00:00Z",
         "source" : {
            "action" : "string",
            "admin_id" : "string",
            "date" : "2019-01-01T00:00:00Z",
            "facilitator" : "string",
            "remote_addresses" : [
               "string"
            ],
            "user_id" : "string"
         }
      },
      "healthy" : true,
      "history" : [
         null
      ],
      "pending" : null
   },
   "region" : "string",
   "security" : {
      "last_modified" : "2019-01-01T00:00:00Z",
      "roles" : {},
      "users" : [
         {
            "password_hash" : "string",
            "username" : "string"
         }
      ],
      "users_roles" : [
         {
            "roles" : [
               "string"
            ],
            "username" : "string"
         }
      ],
      "version" : 0
   },
   "settings" : {
      "ccs" : {
         "remote_clusters" : {
            "some_property" : {
               "cluster_id" : "string",
               "skip_unavailable" : true
            }
         }
      },
      "curation" : {
         "specs" : [
            {
               "index_pattern" : "string",
               "trigger_interval_seconds" : 0
            }
         ]
      },
      "dedicated_masters_threshold" : 0,
      "ip_filtering" : {
         "rulesets" : [
            "string"
         ]
      },
      "metadata" : {
         "contact_email" : "string",
         "hidden" : true,
         "name" : "string",
         "owner_id" : "string",
         "resources" : {
            "cpu" : {
               "boost" : true,
               "hard_limit" : true
            }
         },
         "subscription_level" : "string",
         "system_owned" : true
      },
      "monitoring" : {
         "target_cluster_id" : "string"
      },
      "snapshot" : {
         "enabled" : true,
         "interval" : "string",
         "pending_interval" : "string",
         "repository" : {
            "default" : {},
            "reference" : {
               "repository_name" : "string"
            },
            "static" : {
               "repository_type" : "string",
               "settings" : {}
            }
         },
         "repository_name" : "string",
         "retention" : {
            "max_age" : "string",
            "snapshots" : 0
         },
         "suspended" : [
            "string"
         ],
         "wait_time_after_snapshotting" : "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",
         "instance_name" : "string",
         "timestamp" : "2019-01-01T00:00:00Z",
         "url" : "string"
      }
   ],
   "topology" : {
      "healthy" : true,
      "instances" : [
         {
            "allocator_id" : "string",
            "container_started" : true,
            "disk" : {
               "disk_space_available" : 0,
               "disk_space_used" : 0,
               "storage_multiplier" : 0.1
            },
            "healthy" : true,
            "instance_configuration" : {
               "id" : "string",
               "name" : "string",
               "resource" : "string"
            },
            "instance_name" : "string",
            "maintenance_mode" : true,
            "memory" : {
               "instance_capacity" : 0,
               "instance_capacity_planned" : 0,
               "memory_pressure" : 0,
               "native_memory_pressure" : 0
            },
            "service_id" : "string",
            "service_roles" : [
               "string"
            ],
            "service_running" : true,
            "service_version" : "string",
            "zone" : "string"
         }
      ]
   }
}

ElasticsearchClusterInstanceSettingsOverrides

The override settings for an Elasticsearch instance.

Properties

instance_capacity (integer as int32)
Sets the memory capacity for the instance's container. Requires a restart to take effect.
storage_multiplier (number as double)
Overrides the disk quota multiplier for the instance.

Example

{
   "instance_capacity" : 0,
   "storage_multiplier" : 0.1
}

ElasticsearchClusterPlan

The plan for the Elasticsearch cluster.

Properties

cluster_topology (array[ElasticsearchClusterTopologyElement], required)
deployment_template (DeploymentTemplateReference)
Documents which deployment template was used in the creation of this plan
elasticsearch (ElasticsearchConfiguration, required)
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
tiebreaker_override (boolean)
DEPRECATED: Scheduled for removal in a future version of the API. Whether to add a tiebreaker node in an unused zone (defaults to auto-decide based on topology). If master nodes are specified then this cannot be left blank, you must explictly decide true or false.
tiebreaker_topology (TiebreakerTopologyElement)
DEPRECATED: Scheduled for removal in a future version of the API. Defines the topology (capacity and location) of the special tiebreaker node. If masters nodes are present, their topology acts as a default for the tiebreaker topology
transient (TransientElasticsearchPlanConfiguration)
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
zone_count (integer as int32)
DEPRECATED: Scheduled for removal in a future version of the API. Please use cluster_topology.zone_count instead. The default number of zones in which data nodes will be placed, if not specified in the per topology settings

Example

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

ElasticsearchClusterPlanInfo

Information about the Elasticsearch cluster plan.

Properties

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

Example

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

ElasticsearchClusterPlansInfo

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

Properties

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

Example

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

ElasticsearchClusterRole

The authorization information for an Elasticsearch cluster user.

Properties

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

Example

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

ElasticsearchClusterSecurityInfo

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

Properties

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

Example

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

ElasticsearchClusterSettings

The settings for an Elasticsearch cluster.

Properties

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

Example

{
   "ccs" : {
      "remote_clusters" : {
         "some_property" : {
            "cluster_id" : "string",
            "skip_unavailable" : true
         }
      }
   },
   "curation" : {
      "specs" : [
         {
            "index_pattern" : "string",
            "trigger_interval_seconds" : 0
         }
      ]
   },
   "dedicated_masters_threshold" : 0,
   "ip_filtering" : {
      "rulesets" : [
         "string"
      ]
   },
   "metadata" : {
      "contact_email" : "string",
      "hidden" : true,
      "name" : "string",
      "owner_id" : "string",
      "resources" : {
         "cpu" : {
            "boost" : true,
            "hard_limit" : true
         }
      },
      "subscription_level" : "string",
      "system_owned" : true
   },
   "monitoring" : {
      "target_cluster_id" : "string"
   },
   "snapshot" : {
      "enabled" : true,
      "interval" : "string",
      "pending_interval" : "string",
      "repository" : {
         "default" : {},
         "reference" : {
            "repository_name" : "string"
         },
         "static" : {
            "repository_type" : "string",
            "settings" : {}
         }
      },
      "repository_name" : "string",
      "retention" : {
         "max_age" : "string",
         "snapshots" : 0
      },
      "suspended" : [
         "string"
      ],
      "wait_time_after_snapshotting" : "string"
   }
}

ElasticsearchClusterTopologyElement

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

Properties

allocator_filter (object)
DEPRECATED: Scheduled for removal in a future version of the API. Controls the allocation strategy of this node type using a simplified version of the Elasticsearch filter DSL (together with 'node_configuration')
elasticsearch (ElasticsearchConfiguration)
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
instance_configuration_id (string)
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
memory_per_node (integer as int32)
The memory capacity in MB for each node of this type built in each zone.
node_configuration (string)
DEPRECATED: Scheduled for removal in a future version of the API. Please use instance_configuration_id. Controls the allocation strategy of this node type by pointing to the names of pre-registered allocator settings. Unless otherwise specified for this deployment, only 'default' is supported (equivalent to omitting).
node_count_per_zone (integer as int32)
The number of nodes of this type that are allocated within each zone. (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB). Cannot be set for tiebreaker topologies. For dedicated master nodes, must be 1 if an entry exists.
node_type (ElasticsearchNodeType)
Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.
size (TopologySize)
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
zone_count (integer as int32)
The default number of zones in which data nodes will be placed

Example

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

ElasticsearchClusterUser

The information about an Elasticsearch cluster user.

Properties

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

Example

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

ElasticsearchClustersInfo

Information about a set of Elasticsearch clusters.

Properties

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

Example

{
   "elasticsearch_clusters" : [
      {
         "associated_apm_clusters" : [
            {
               "apm_id" : "string",
               "enabled" : true,
               "links" : {
                  "some_property" : {
                     "need_elevated_permissions" : true
                  }
               }
            }
         ],
         "associated_kibana_clusters" : [
            {
               "enabled" : true,
               "kibana_id" : "string",
               "links" : {
                  "some_property" : null
               }
            }
         ],
         "ccs" : {
            "healthy" : true,
            "remote_clusters" : [
               {
                  "compatible" : true,
                  "id" : "string",
                  "version" : "string"
               }
            ]
         },
         "cluster_id" : "string",
         "cluster_name" : "string",
         "elasticsearch" : {
            "blocking_issues" : {
               "cluster_level" : [
                  {
                     "description" : "string",
                     "instances" : [
                        "string"
                     ]
                  }
               ],
               "healthy" : true,
               "index_level" : [
                  null
               ]
            },
            "healthy" : true,
            "master_info" : {
               "healthy" : true,
               "instances_with_no_master" : [
                  "string"
               ],
               "masters" : [
                  {
                     "instances" : [
                        "string"
                     ],
                     "master_instance_name" : "string",
                     "master_node_id" : "string"
                  }
               ]
            },
            "shard_info" : {
               "available_shards" : [
                  {
                     "instance_name" : "string",
                     "shard_count" : 0
                  }
               ],
               "healthy" : true,
               "unavailable_replicas" : [
                  {
                     "instance_name" : "string",
                     "replica_count" : 0
                  }
               ],
               "unavailable_shards" : [
                  null
               ]
            }
         },
         "elasticsearch_monitoring_info" : {
            "destination_cluster_ids" : [
               "string"
            ],
            "healthy" : true,
            "last_modified" : "2019-01-01T00:00:00Z",
            "last_update_status" : "string",
            "source_cluster_ids" : [
               "string"
            ]
         },
         "external_links" : [
            {
               "id" : "string",
               "label" : "string",
               "uri" : "string"
            }
         ],
         "healthy" : true,
         "links" : {
            "some_property" : null
         },
         "locked" : true,
         "metadata" : {
            "cloud_id" : "string",
            "endpoint" : "string",
            "last_modified" : "2019-01-01T00:00:00Z",
            "ports" : {
               "http" : 0,
               "https" : 0
            },
            "raw" : {},
            "version" : 0
         },
         "plan_info" : {
            "current" : {
               "attempt_end_time" : "2019-01-01T00:00:00Z",
               "attempt_start_time" : "2019-01-01T00:00:00Z",
               "healthy" : true,
               "plan" : {
                  "cluster_topology" : [
                     {
                        "allocator_filter" : {},
                        "elasticsearch" : {
                           "curation" : {
                              "from_instance_configuration_id" : "string",
                              "to_instance_configuration_id" : "string"
                           },
                           "docker_image" : "string",
                           "enabled_built_in_plugins" : [
                              "string"
                           ],
                           "node_attributes" : {
                              "some_property" : "string"
                           },
                           "system_settings" : {
                              "auto_create_index" : true,
                              "default_shards_per_index" : 0,
                              "destructive_requires_name" : true,
                              "enable_close_index" : true,
                              "monitoring_collection_interval" : 0,
                              "monitoring_history_duration" : "string",
                              "reindex_whitelist" : [
                                 "string"
                              ],
                              "scripting" : {
                                 "expressions_enabled" : true,
                                 "file" : {
                                    "enabled" : true,
                                    "sandbox_mode" : true
                                 },
                                 "inline" : null,
                                 "mustache_enabled" : true,
                                 "painless_enabled" : true,
                                 "stored" : null
                              },
                              "use_disk_threshold" : true,
                              "watcher_trigger_engine" : "string"
                           },
                           "user_bundles" : [
                              {
                                 "elasticsearch_version" : "string",
                                 "name" : "string",
                                 "url" : "string"
                              }
                           ],
                           "user_plugins" : [
                              {
                                 "elasticsearch_version" : "string",
                                 "name" : "string",
                                 "url" : "string"
                              }
                           ],
                           "user_settings_json" : {},
                           "user_settings_override_json" : {},
                           "user_settings_override_yaml" : "string",
                           "user_settings_yaml" : "string",
                           "version" : "string"
                        },
                        "instance_configuration_id" : "string",
                        "memory_per_node" : 0,
                        "node_configuration" : "string",
                        "node_count_per_zone" : 0,
                        "node_type" : {
                           "data" : true,
                           "ingest" : true,
                           "master" : true,
                           "ml" : true
                        },
                        "size" : {
                           "resource" : "string",
                           "value" : 0
                        },
                        "zone_count" : 0
                     }
                  ],
                  "deployment_template" : {
                     "id" : "string",
                     "version" : "string"
                  },
                  "elasticsearch" : null,
                  "tiebreaker_override" : true,
                  "tiebreaker_topology" : {
                     "memory_per_node" : 0
                  },
                  "transient" : {
                     "cluster_settings_json" : {},
                     "plan_configuration" : {
                        "calm_wait_time" : 0,
                        "cluster_reboot" : "string",
                        "extended_maintenance" : true,
                        "max_snapshot_age" : 0,
                        "max_snapshot_attempts" : 0,
                        "move_allocators" : [
                           {
                              "allocator_down" : true,
                              "from" : "string",
                              "to" : [
                                 "string"
                              ]
                           }
                        ],
                        "move_instances" : [
                           {
                              "from" : "string",
                              "instance_down" : true,
                              "to" : [
                                 "string"
                              ]
                           }
                        ],
                        "move_only" : true,
                        "override_failsafe" : true,
                        "preferred_allocators" : [
                           "string"
                        ],
                        "reallocate_instances" : true,
                        "skip_data_migration" : true,
                        "skip_post_upgrade_steps" : true,
                        "skip_snapshot" : true,
                        "skip_upgrade_checker" : true,
                        "timeout" : 0
                     },
                     "restore_snapshot" : {
                        "repository_config" : {
                           "raw_settings" : {}
                        },
                        "repository_name" : "string",
                        "restore_payload" : {
                           "indices" : [
                              "string"
                           ],
                           "raw_settings" : {}
                        },
                        "snapshot_name" : "string",
                        "source_cluster_id" : "string",
                        "strategy" : "string"
                     },
                     "strategy" : {
                        "grow_and_shrink" : {},
                        "rolling" : {
                           "allow_inline_resize" : true,
                           "group_by" : "string",
                           "shard_init_wait_time" : 0,
                           "skip_synced_flush" : true
                        },
                        "rolling_grow_and_shrink" : {}
                     }
                  },
                  "zone_count" : 0
               },
               "plan_attempt_id" : "string",
               "plan_attempt_log" : [
                  {
                     "completed" : "2019-01-01T00:00:00Z",
                     "duration_in_millis" : 0,
                     "info_log" : [
                        {
                           "delta_in_millis" : 0,
                           "message" : "string",
                           "stage" : "string",
                           "timestamp" : "2019-01-01T00:00:00Z"
                        }
                     ],
                     "stage" : "string",
                     "started" : "2019-01-01T00:00:00Z",
                     "status" : "string",
                     "step_id" : "string"
                  }
               ],
               "plan_attempt_name" : "string",
               "plan_end_time" : "2019-01-01T00:00:00Z",
               "source" : {
                  "action" : "string",
                  "admin_id" : "string",
                  "date" : "2019-01-01T00:00:00Z",
                  "facilitator" : "string",
                  "remote_addresses" : [
                     "string"
                  ],
                  "user_id" : "string"
               }
            },
            "healthy" : true,
            "history" : [
               null
            ],
            "pending" : null
         },
         "region" : "string",
         "security" : {
            "last_modified" : "2019-01-01T00:00:00Z",
            "roles" : {},
            "users" : [
               {
                  "password_hash" : "string",
                  "username" : "string"
               }
            ],
            "users_roles" : [
               {
                  "roles" : [
                     "string"
                  ],
                  "username" : "string"
               }
            ],
            "version" : 0
         },
         "settings" : {
            "ccs" : {
               "remote_clusters" : {
                  "some_property" : {
                     "cluster_id" : "string",
                     "skip_unavailable" : true
                  }
               }
            },
            "curation" : {
               "specs" : [
                  {
                     "index_pattern" : "string",
                     "trigger_interval_seconds" : 0
                  }
               ]
            },
            "dedicated_masters_threshold" : 0,
            "ip_filtering" : {
               "rulesets" : [
                  "string"
               ]
            },
            "metadata" : {
               "contact_email" : "string",
               "hidden" : true,
               "name" : "string",
               "owner_id" : "string",
               "resources" : {
                  "cpu" : {
                     "boost" : true,
                     "hard_limit" : true
                  }
               },
               "subscription_level" : "string",
               "system_owned" : true
            },
            "monitoring" : {
               "target_cluster_id" : "string"
            },
            "snapshot" : {
               "enabled" : true,
               "interval" : "string",
               "pending_interval" : "string",
               "repository" : {
                  "default" : {},
                  "reference" : {
                     "repository_name" : "string"
                  },
                  "static" : {
                     "repository_type" : "string",
                     "settings" : {}
                  }
               },
               "repository_name" : "string",
               "retention" : {
                  "max_age" : "string",
                  "snapshots" : 0
               },
               "suspended" : [
                  "string"
               ],
               "wait_time_after_snapshotting" : "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",
               "instance_name" : "string",
               "timestamp" : "2019-01-01T00:00:00Z",
               "url" : "string"
            }
         ],
         "topology" : {
            "healthy" : true,
            "instances" : [
               {
                  "allocator_id" : "string",
                  "container_started" : true,
                  "disk" : {
                     "disk_space_available" : 0,
                     "disk_space_used" : 0,
                     "storage_multiplier" : 0.1
                  },
                  "healthy" : true,
                  "instance_configuration" : {
                     "id" : "string",
                     "name" : "string",
                     "resource" : "string"
                  },
                  "instance_name" : "string",
                  "maintenance_mode" : true,
                  "memory" : {
                     "instance_capacity" : 0,
                     "instance_capacity_planned" : 0,
                     "memory_pressure" : 0,
                     "native_memory_pressure" : 0
                  },
                  "service_id" : "string",
                  "service_roles" : [
                     "string"
                  ],
                  "service_running" : true,
                  "service_version" : "string",
                  "zone" : "string"
               }
            ]
         }
      }
   ],
   "match_count" : 0,
   "return_count" : 0
}

ElasticsearchConfiguration

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

Properties

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

Example

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

ElasticsearchCuration

The structure that defines the routing settings for index curation.

Properties

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

Example

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

ElasticsearchInfo

Information about the Elasticsearch cluster.

Properties

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

Example

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

ElasticsearchMasterElement

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

Properties

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

Example

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

ElasticsearchMasterInfo

Information about the master nodes in the Elasticsearch cluster.

Properties

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

Example

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

ElasticsearchMonitoringInfo

Information about the monitoring status for the Elasticsearch cluster.

Properties

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

Example

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

ElasticsearchNodeType

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

Properties

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

Example

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

ElasticsearchPlanControlConfiguration

The configuration settings for the timeout and fallback parameters.

Properties

calm_wait_time (integer as int64)
This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
cluster_reboot (string; allowed values: [forced])
Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)
extended_maintenance (boolean)
If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
max_snapshot_age (integer as int64)
When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300
max_snapshot_attempts (integer as int32)
If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)
move_allocators (array[AllocatorMoveRequest])
move_instances (array[InstanceMoveRequest])
move_only (boolean)
If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored
override_failsafe (boolean)
If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints
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
skip_data_migration (boolean)
If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)
skip_post_upgrade_steps (boolean)
If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)
skip_snapshot (boolean)
If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster
skip_upgrade_checker (boolean)
If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed
timeout (integer as int64)
The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: (eg a 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds)

Example

{
   "calm_wait_time" : 0,
   "cluster_reboot" : "string",
   "extended_maintenance" : true,
   "max_snapshot_age" : 0,
   "max_snapshot_attempts" : 0,
   "move_allocators" : [
      {
         "allocator_down" : true,
         "from" : "string",
         "to" : [
            "string"
         ]
      }
   ],
   "move_instances" : [
      {
         "from" : "string",
         "instance_down" : true,
         "to" : [
            "string"
         ]
      }
   ],
   "move_only" : true,
   "override_failsafe" : true,
   "preferred_allocators" : [
      "string"
   ],
   "reallocate_instances" : true,
   "skip_data_migration" : true,
   "skip_post_upgrade_steps" : true,
   "skip_snapshot" : true,
   "skip_upgrade_checker" : true,
   "timeout" : 0
}

ElasticsearchReplicaElement

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

Properties

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

Example

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

ElasticsearchScriptTypeSettings

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

Properties

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

Example

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

ElasticsearchScriptingUserSettings

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

Properties

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

Example

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

ElasticsearchShardElement

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

Properties

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

Example

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

ElasticsearchShardsInfo

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

Properties

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

Example

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

ElasticsearchSystemSettings

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

Properties

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

Example

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

ElasticsearchUserBundle

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

Properties

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

Example

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

ElasticsearchUserPlugin

A list of admin-uploaded plugin objects.

Properties

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

Example

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

ElevatePermissionsRequest

The request body for elevated permissions.

Properties

token (string, required)
Multi-factor authorization token

Example

{
   "token" : "string"
}

EmptyResponse

Intentionally left blank

Example

{}

EnrollmentTokenRequest

An enrollment token request for one or more services.

Properties

persistent (boolean, required)
Whether this token can subsequently to its grant be revoked from the UI
roles (array[string])
The additional services for which this enrollment token applies (empty if not specified, ie system services only)
validity_in_seconds (integer as int32)
The time in seconds for which this token is valid (defaults to 1 hour). Currently this can only be set for ephemeral (persistent: false) tokens.

Example

{
   "persistent" : true,
   "roles" : [
      "string"
   ],
   "validity_in_seconds" : 0
}

ExistsQuery

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

Properties

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

Example

{
   "field" : "string"
}

ExternalHyperlink

Intentionally left blank

Properties

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

Example

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

FilterAssociation

The association with a ruleset or user auth token for a deployment, template, or product.

Properties

entity_type (string, required)
Type of the IP filter ruleset association, such as 'deployment', 'cluster'
id (string, required)
ID of the entity, such as the deployment ID or Elasticsearch cluster ID.

Example

{
   "entity_type" : "string",
   "id" : "string"
}

GrowShrinkStrategyConfig

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

Example

{}

Hyperlink

Intentionally left blank

Properties

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

Example

{
   "need_elevated_permissions" : true
}

IdResponse

Intentionally left blank

Properties

id (string, required)
The ID

Example

{
   "id" : "string"
}

InstanceConfiguration

The configuration template for Elasticsearch instances, Kibana instances, and APM Servers.

Properties

allocator_filter (QueryContainer)
Optional filter to match allocators against
deleted_on (string as date-time)
Date/time that this instance configuration was marked for deletion
description (string)
Optional description for the instance configuration
discrete_sizes (DiscreteSizes, required)
Numerics representing possible instance sizes that the instance configuration supports.
id (string)
Unique identifier for the instance configuration
instance_type (string, required)
The type of instance (elasticsearch, kibana)
metadata (object)
Optional arbitrary metadata to associate with this template.
name (string, required)
Display name for the instance configuration.
node_types (array[string])
Node types (master, data) for the instance
storage_multiplier (number as double)
Settings for the instance storage multiplier
system_owned (boolean)
Indicates if a instance configuration is system owned (restricts the set of operations that can be performed on it)

Example

{
   "allocator_filter" : {
      "bool" : {
         "filter" : [
            null
         ],
         "minimum_should_match" : 0,
         "must" : [
            null
         ],
         "must_not" : [
            null
         ],
         "should" : [
            null
         ]
      },
      "exists" : {
         "field" : "string"
      },
      "match" : {
         "some_property" : {
            "analyzer" : "string",
            "minimum_should_match" : 0,
            "operator" : "string",
            "query" : "string"
         }
      },
      "match_all" : {},
      "match_none" : {},
      "nested" : {
         "path" : "string",
         "query" : null,
         "score_mode" : "string"
      },
      "prefix" : {
         "some_property" : {
            "boost" : 0.1,
            "value" : "string"
         }
      },
      "query_string" : {
         "allow_leading_wildcard" : true,
         "analyzer" : "string",
         "default_field" : "string",
         "default_operator" : "string",
         "query" : "string"
      },
      "range" : {
         "some_property" : {
            "boost" : 0.1,
            "format" : "string",
            "gt" : {},
            "gte" : {},
            "lt" : {},
            "lte" : {},
            "time_zone" : "string"
         }
      },
      "term" : {
         "some_property" : {
            "value" : {}
         }
      }
   },
   "deleted_on" : "2019-01-01T00:00:00Z",
   "description" : "string",
   "discrete_sizes" : {
      "default_size" : 0,
      "resource" : "string",
      "sizes" : [
         0
      ]
   },
   "id" : "string",
   "instance_type" : "string",
   "metadata" : {},
   "name" : "string",
   "node_types" : [
      "string"
   ],
   "storage_multiplier" : 0.1,
   "system_owned" : true
}

InstanceMoveRequest

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

Properties

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

Example

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

InstanceTypeResource

Intentionally left blank

Properties

compatibility (array[CompatibleVersionResource], required)
Compatible versions
default_instance_configuration_id (string)
Id of the default instance configuration to use for this instance type.
description (string, required)
Instance type description
instance_type (string, required)
Instance type, the key for this resource
name (string, required)
Instance type name
node_types (array[NodeTypeResource], required)
Supported node types

Example

{
   "compatibility" : [
      {
         "capacity_constraints" : {
            "max" : 0,
            "min" : 0
         },
         "node_types" : [
            {
               "capacity_constraints" : null,
               "compatible_node_types" : [
                  "string"
               ],
               "node_type" : "string"
            }
         ],
         "version" : "string"
      }
   ],
   "default_instance_configuration_id" : "string",
   "description" : "string",
   "instance_type" : "string",
   "name" : "string",
   "node_types" : [
      {
         "default_instance_configuration_id" : "string",
         "description" : "string",
         "name" : "string",
         "node_type" : "string"
      }
   ]
}

IpFilterRule

The container for an IP filter rule.

Properties

description (string)
Description of the rule
id (string)
The rule ID
source (string, required)
IPV4, IPV6 address or CIDR mask to define single or range of IPs

Example

{
   "description" : "string",
   "id" : "string",
   "source" : "string"
}

IpFilterRuleset

The container for multiple IP filter rulesets.

Properties

associations (array[FilterAssociation])
List of associations. Returned only when include_associations query parameter is true
description (string)
Description of the ruleset
id (string)
The ruleset ID
name (string, required)
Name of the ruleset
rules (array[IpFilterRule], required)
List of rules
total_associations (integer as int32)
Total number of associations. This includes associations user doesn't have permission to view.Returned only when include_associations query parameter is true

Example

{
   "associations" : [
      {
         "entity_type" : "string",
         "id" : "string"
      }
   ],
   "description" : "string",
   "id" : "string",
   "name" : "string",
   "rules" : [
      {
         "description" : "string",
         "id" : "string",
         "source" : "string"
      }
   ],
   "total_associations" : 0
}

IpFilterRulesets

The container for a set of IP filter rulesets.

Properties

rulesets (array[IpFilterRuleset], required)
List of rules

Example

{
   "rulesets" : [
      {
         "associations" : [
            {
               "entity_type" : "string",
               "id" : "string"
            }
         ],
         "description" : "string",
         "id" : "string",
         "name" : "string",
         "rules" : [
            {
               "description" : "string",
               "id" : "string",
               "source" : "string"
            }
         ],
         "total_associations" : 0
      }
   ]
}

IpFilteringSettings

The configuration settings for IP filtering.

Properties

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

Example

{
   "rulesets" : [
      "string"
   ]
}

KeystoreContents

The contents of the Elasticsearch keystore.

Properties

secrets (map[string,KeystoreSecret], required)
List of secrets

Example

{
   "secrets" : {
      "some_property" : {
         "as_file" : true,
         "value" : {}
      }
   }
}

KeystoreSecret

The value that you configure for the Elasticsearch keystore secret.

Properties

as_file (boolean)
Stores the keystore secret as a file. The default is false, which stores the keystore secret as string when value is a plain string, or true when value is an object.
value (object)
Value of this setting. This can either be a string or a JSON object that is stored as a JSON string in the keystore. NOTE: When the keystore secret is unspecified, it is removed.

Example

{
   "as_file" : true,
   "value" : {}
}

KibanaClusterInfo

The top-level object information for a Kibana instance.

Properties

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

Example

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

KibanaClusterPlan

The plan for the Kibana instance.

Properties

cluster_topology (array[KibanaClusterTopologyElement])
kibana (KibanaConfiguration, required)
The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
transient (TransientKibanaPlanConfiguration)
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings.
zone_count (integer as int32)
DEPRECATED: Scheduled for removal in a future version of the API. Please use cluster_topology.zone_count instead. The number of zones in which data nodes will be placed, if not specified in the per topology settings

Example

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

KibanaClusterPlanInfo

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

Properties

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

Example

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

KibanaClusterPlansInfo

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

Properties

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

Example

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

KibanaClusterSettings

The settings for multiple Kibana instances.

Properties

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

Example

{
   "metadata" : {
      "contact_email" : "string",
      "hidden" : true,
      "name" : "string",
      "owner_id" : "string",
      "resources" : {
         "cpu" : {
            "boost" : true,
            "hard_limit" : true
         }
      },
      "subscription_level" : "string",
      "system_owned" : true
   }
}

KibanaClusterTopologyElement

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

Properties

allocator_filter (object)
DEPRECATED: Scheduled for removal in a future version of the API. Controls the allocation strategy of this node type using a simplified version of the Elasticsearch filter DSL (together with 'node_configuration')
instance_configuration_id (string)
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
kibana (KibanaConfiguration)
The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
memory_per_node (integer as int32)
The memory capacity in MB for each node of this type built in each zone.
node_configuration (string)
DEPRECATED: Scheduled for removal in a future version of the API. Controls the allocation strategy of this node type by pointing to the names of pre-registered allocator settings. Unless otherwise specified for this deployment, should be omitted.
node_count_per_zone (integer as int32)
The number of nodes of this type that are allocated within each zone (i.e. total capacity per zone = node_count_per_zone * memory_per_node in MB).
size (TopologySize)
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
zone_count (integer as int32)
number of zones in which nodes will be placed

Example

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

KibanaClustersInfo

Information about a set of Kibana instances.

Properties

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

Example

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

KibanaConfiguration

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

Properties

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

Example

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

KibanaPlanControlConfiguration

The configuration settings for the timeout and fallback parameters.

Properties

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

Example

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

KibanaSubClusterInfo

Information about the Kibana instances associated with the Elasticsearch cluster.

Properties

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

Example

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

KibanaSystemSettings

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

Properties

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

Example

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

LdapGroupSearch

The group search configuration for the Elasticsearch security LDAP realm.

Properties

base_dn (string)
Specifies a container DN to search for groups in which the user has membership
filter (string)
Specifies a filter to search for a group. When unspecified, the security realm searches for group, groupOfNames, groupOfUniqueNames, or posixGroup with the attributes member, memberOf, or memberUid. Any instance of {0} in the filter is replaced by the user attribute defined in user_attribute.
scope (string; allowed values: [sub_tree, one_level, base])
Specifies whether the group search should be sub_tree, one_level or base. one_level only searches objects directly contained within the base_dn. The default sub_tree searches all objects contained under base_dn. base specifies that the base_dn is a group object, and that it is the only group considered.
user_attribute (string)
Specifies the user attribute that is fetched and provided as a parameter to the filter. When unspecified, the user DN is passed to the filter.

Example

{
   "base_dn" : "string",
   "filter" : "string",
   "scope" : "string",
   "user_attribute" : "string"
}

LdapSecurityRealmLoadBalance

The load balancing configuration for the Elasticsearch security LDAP realm.

Properties

cache_ttl (string)
When using dns_failover or dns_round_robin as the load balancing type, this setting controls the amount of time to cache DNS lookups. Defaults to 1h.
type (string; allowed values: [failover, dns_failover, round_robin, dns_round_robin], required)
The behavior to use when there are multiple LDAP URLs defined

Example

{
   "cache_ttl" : "string",
   "type" : "string"
}

LdapSecurityRealmRoleMappingRule

The role mapping rule for the Elasticsearch security LDAP realm.

Properties

roles (array[string], required)
The roles that are applied when the mapping rule is successfully evaluated
type (string; allowed values: [user_dn, group_dn], required)
The type of role mapping rule
value (string, required)
The value to match when evaluating this rule

Example

{
   "roles" : [
      "string"
   ],
   "type" : "string",
   "value" : "string"
}

LdapSecurityRealmRoleMappingRules

The role mapping ruleset for the Elasticsearch security LDAP realm.

Properties

default_roles (array[string], required)
The default roles applied to all users
rules (array[LdapSecurityRealmRoleMappingRule], required)
The role mapping rules to evaluate

Example

{
   "default_roles" : [
      "string"
   ],
   "rules" : [
      {
         "roles" : [
            "string"
         ],
         "type" : "string",
         "value" : "string"
      }
   ]
}

LdapSettings

The configuration for the Elasticsearch security LDAP realm.

Properties

bind_anonymously (boolean, required)
When true, bindDb credentials are ignored
bind_dn (string)
The distinguished name of the user that is used to bind to the LDAP and perform searches. Only used when bind_type is set to 'user_search'.
bind_password (string)
The user password that is used to bind to the LDAP server. Only used when bind_type is set to 'user_search'.
bind_type (string; allowed values: [user_search, user_templates], required)
The type of user binding to apply
certificate_url (string)
The SSL trusted CA certificate bundle URL. The bundle should be a zip file containing a single keystore file 'keystore.ks' in the directory '/ldap/:id/truststore', where :id is the value of the [id] field.
certificate_url_truststore_password (string)
The password to the certificate bundle URL truststore
certificate_url_truststore_type (string; allowed values: [jks, PKCS12])
The format of the keystore file. Should be jks to use the Java Keystore format or PKCS12 to use PKCS#12 files. The default is jks.
enabled (boolean)
When true, enables the security realm
group_search (LdapGroupSearch)
The LDAP group search configuration
id (string, required)
The identifier for the security realm
load_balance (LdapSecurityRealmLoadBalance)
The LDAP load balancing behavior
name (string, required)
The friendly name of the security realm
order (integer as int32)
The order that the security realm is evaluated
override_yaml (string)
Advanced configuration options in YAML format. Any settings defined here will override any configuration set via the API.
role_mappings (LdapSecurityRealmRoleMappingRules)
The role mapping rules associated with the security realm
urls (array[string], required)
The LDAP URLs used to authenticate against, in the format ldap[s]://server:port. Note that ldap and ldaps protocols cannot be mixed together.
user_dn_templates (array[string])
The distinguished name template that replaces the user name with the string {0}. Only used when bind_type is set to 'user_templates'.
user_group_attribute (string)
Specifies the attribute to examine on the user for group membership. If any 'group_search' settings are specified, this setting is ignored. Defaults to 'memberOf'.
user_search (LdapUserSearch)
The LDAP user search configuration. Only used when bind_type is set to 'user_search'.

Example

{
   "bind_anonymously" : true,
   "bind_dn" : "string",
   "bind_password" : "string",
   "bind_type" : "string",
   "certificate_url" : "string",
   "certificate_url_truststore_password" : "string",
   "certificate_url_truststore_type" : "string",
   "enabled" : true,
   "group_search" : {
      "base_dn" : "string",
      "filter" : "string",
      "scope" : "string",
      "user_attribute" : "string"
   },
   "id" : "string",
   "load_balance" : {
      "cache_ttl" : "string",
      "type" : "string"
   },
   "name" : "string",
   "order" : 0,
   "override_yaml" : "string",
   "role_mappings" : {
      "default_roles" : [
         "string"
      ],
      "rules" : [
         {
            "roles" : [
               "string"
            ],
            "type" : "string",
            "value" : "string"
         }
      ]
   },
   "urls" : [
      "string"
   ],
   "user_dn_templates" : [
      "string"
   ],
   "user_group_attribute" : "string",
   "user_search" : {
      "base_dn" : "string",
      "filter" : "string",
      "scope" : "string"
   }
}

LdapUserSearch

The user search configuration for the Elasticsearch security LDAP realm.

Properties

base_dn (string)
Specifies a container DN to search for users
filter (string)
Specifies the filter to search the directory and match an entry with the username provided by the user. Defaults to (uid={0}). {0} is substituted with the username provided when searching.
scope (string; allowed values: [sub_tree, one_level, base])
The scope of the user search. Valid values are sub_tree, one_level, or base. one_level only searches objects directly contained in the base_dn. sub_tree searches all objects contained in base_dn. base specifies that the base_dn is the user object, and that it is the only user considered. Defaults to sub_tree.

Example

{
   "base_dn" : "string",
   "filter" : "string",
   "scope" : "string"
}

LegacySecuritySettings

Intentionally left blank

Properties

roles_yaml (string)
The 'roles' YAML Shield definition
users_roles_yaml (string)
The 'users_roles' YAML Shield definition
users_yaml (string)
The 'users' YAML Shield definition

Example

{
   "roles_yaml" : "string",
   "users_roles_yaml" : "string",
   "users_yaml" : "string"
}

LicenseInfo

Information about a license.

Properties

cluster_licenses (array[ClusterLicenseInfo])
List of cluster licenses
expiry_date_in_millis (integer as int64, required)
When the license expires, in milliseconds since the Unix epoch
issue_date_in_millis (integer as int64, required)
When the license was issued, in milliseconds since the Unix epoch
issued_to (string, required)
Entity the license was issued to
issuer (string, required)
Issuer of the license
max_allocators (integer as int32)
Maximum number of allocators. Empty for version >= 3
max_instances (integer as int32)
Maximum number of instances. Only present for version 3
max_ram_per_allocator_mb (integer as int32)
Maximum RAM per allocator in MB. Empty for version >= 3
operation_mode (string)
Operation mode
signature (string, required)
Digital signature
start_date_in_millis (integer as int64, required)
Initial validity of the license, in milliseconds since the Unix epoch
subscription_type (string)
Type of the license subscription
type (string, required)
Type of the license
uid (string, required)
Unique identifier of the license
version (integer as int32)
Version of the license

Example

{
   "cluster_licenses" : [
      {
         "license" : {}
      }
   ],
   "expiry_date_in_millis" : 0,
   "issue_date_in_millis" : 0,
   "issued_to" : "string",
   "issuer" : "string",
   "max_allocators" : 0,
   "max_instances" : 0,
   "max_ram_per_allocator_mb" : 0,
   "operation_mode" : "string",
   "signature" : "string",
   "start_date_in_millis" : 0,
   "subscription_type" : "string",
   "type" : "string",
   "uid" : "string",
   "version" : 0
}

LicenseObject

The container for a license.

Properties

license (LicenseInfo, required)
License data
usage_stats (UsageStats)
Information about current usage.

Example

{
   "license" : {
      "cluster_licenses" : [
         {
            "license" : {}
         }
      ],
      "expiry_date_in_millis" : 0,
      "issue_date_in_millis" : 0,
      "issued_to" : "string",
      "issuer" : "string",
      "max_allocators" : 0,
      "max_instances" : 0,
      "max_ram_per_allocator_mb" : 0,
      "operation_mode" : "string",
      "signature" : "string",
      "start_date_in_millis" : 0,
      "subscription_type" : "string",
      "type" : "string",
      "uid" : "string",
      "version" : 0
   },
   "usage_stats" : {
      "total_connected_memory_total" : 0
   }
}

ListEnrollmentTokenElement

Information about an active enrollment token.

Properties

roles (array[string], required)
The services for which this enrollment token applies
token_id (string)
An identifier for the token

Example

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

ListEnrollmentTokenReply

Information about active enrollment tokens.

Properties

tokens (array[ListEnrollmentTokenElement])
The list of currently active enrollment tokens

Example

{
   "tokens" : [
      {
         "roles" : [
            "string"
         ],
         "token_id" : "string"
      }
   ]
}

LoginRequest

The body of a login request.

Properties

login_state (LoginState)
Configure how the API responds after a successful login.
password (string, required)
The plain text password part of the login request
username (string, required)
The username part of the login request

Example

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

LoginState

Configure how the API responds after a successful login.

Properties

path (string)
The path to which to redirect post login - if not specified then no redirect is performed, instead 200 is returned with the token in the body

Example

{
   "path" : "string"
}

ManagedMonitoringSettings

The settings for sending monitoring information to another cluster.

Properties

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

Example

{
   "target_cluster_id" : "string"
}

MatchAllQuery

A query that matches all documents.

Example

{}

MatchNoneQuery

A query that doesn't match any documents.

Example

{}

MatchQuery

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

Properties

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

Example

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

MetadataItem

The key-value pair.

Properties

key (string, required)
The metadata field name
value (string, required)
The metadata value

Example

{
   "key" : "string",
   "value" : "string"
}

MetadataItemValue

The value of the metadata item, which is primarily used to add a single item when the key is provided in the URL.

Properties

value (string, required)
The metadata value

Example

{
   "value" : "string"
}

MetadataItems

The container object for metadata items.

Properties

items (array[MetadataItem], required)
A collection of arbitrary metadata items associated with a resource.

Example

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

MoveApmClusterConfiguration

The configuration object for moving APM Servers.

Properties

cluster_ids (array[string], required)
Identifiers for the Apm clusters.
plan_override (TransientApmPlanConfiguration)
Plan override to apply to the Apm clusters being moved.

Example

{
   "cluster_ids" : [
      "string"
   ],
   "plan_override" : {
      "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" : {
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   }
}

MoveApmClusterDetails

Information about the APM Server that you want to move.

Properties

calculated_plan (TransientApmPlanConfiguration)
If only validating the move, then the plan configuration that would be applied to the cluster.
cluster_id (string, required)
Identifier for the Apm cluster.
errors (array[BasicFailedReplyElement])
A list of errors that occurred if the attempt to move the cluster failed.

Example

{
   "calculated_plan" : {
      "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" : {
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   },
   "cluster_id" : "string",
   "errors" : [
      {
         "code" : "string",
         "fields" : [
            "string"
         ],
         "message" : "string"
      }
   ]
}

MoveClustersCommandResponse

Information about the move operations for the Elasticsearch clusters, multiple Kibana instances, and multiple APM Servers, prior to the move.

Properties

failures (MoveClustersDetails, required)
Detailed information about the clusters that failed to move.
moves (MoveClustersDetails, required)
Detailed information about the clusters being moved off the allocator.

Example

{
   "failures" : {
      "apm_clusters" : [
         {
            "calculated_plan" : {
               "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" : {
                  "grow_and_shrink" : {},
                  "rolling" : {
                     "allow_inline_resize" : true,
                     "group_by" : "string",
                     "shard_init_wait_time" : 0,
                     "skip_synced_flush" : true
                  },
                  "rolling_grow_and_shrink" : {}
               }
            },
            "cluster_id" : "string",
            "errors" : [
               {
                  "code" : "string",
                  "fields" : [
                     "string"
                  ],
                  "message" : "string"
               }
            ]
         }
      ],
      "elasticsearch_clusters" : [
         {
            "calculated_plan" : {
               "cluster_settings_json" : {},
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "max_snapshot_age" : 0,
                  "max_snapshot_attempts" : 0,
                  "move_allocators" : [
                     null
                  ],
                  "move_instances" : [
                     null
                  ],
                  "move_only" : true,
                  "override_failsafe" : true,
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "skip_data_migration" : true,
                  "skip_post_upgrade_steps" : true,
                  "skip_snapshot" : true,
                  "skip_upgrade_checker" : true,
                  "timeout" : 0
               },
               "restore_snapshot" : {
                  "repository_config" : {
                     "raw_settings" : {}
                  },
                  "repository_name" : "string",
                  "restore_payload" : {
                     "indices" : [
                        "string"
                     ],
                     "raw_settings" : {}
                  },
                  "snapshot_name" : "string",
                  "source_cluster_id" : "string",
                  "strategy" : "string"
               },
               "strategy" : null
            },
            "cluster_id" : "string",
            "errors" : [
               null
            ]
         }
      ],
      "kibana_clusters" : [
         {
            "calculated_plan" : {
               "plan_configuration" : {
                  "calm_wait_time" : 0,
                  "cluster_reboot" : "string",
                  "extended_maintenance" : true,
                  "move_allocators" : [
                     null
                  ],
                  "move_instances" : [
                     null
                  ],
                  "preferred_allocators" : [
                     "string"
                  ],
                  "reallocate_instances" : true,
                  "timeout" : 0
               },
               "strategy" : null
            },
            "cluster_id" : "string",
            "errors" : [
               null
            ]
         }
      ]
   },
   "moves" : null
}

MoveClustersDetails

Information about the Elasticsearch clusters, multiple Kibana instances, and multiple APM Servers that are moved off of the allocator.

Properties

apm_clusters (array[MoveApmClusterDetails])
Detailed information about the Apm clusters being moved.
elasticsearch_clusters (array[MoveElasticsearchClusterDetails])
Detailed information about the Elasticsearch clusters being moved.
kibana_clusters (array[MoveKibanaClusterDetails])
Detailed information about the Kibana clusters being moved.

Example

{
   "apm_clusters" : [
      {
         "calculated_plan" : {
            "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" : {
               "grow_and_shrink" : {},
               "rolling" : {
                  "allow_inline_resize" : true,
                  "group_by" : "string",
                  "shard_init_wait_time" : 0,
                  "skip_synced_flush" : true
               },
               "rolling_grow_and_shrink" : {}
            }
         },
         "cluster_id" : "string",
         "errors" : [
            {
               "code" : "string",
               "fields" : [
                  "string"
               ],
               "message" : "string"
            }
         ]
      }
   ],
   "elasticsearch_clusters" : [
      {
         "calculated_plan" : {
            "cluster_settings_json" : {},
            "plan_configuration" : {
               "calm_wait_time" : 0,
               "cluster_reboot" : "string",
               "extended_maintenance" : true,
               "max_snapshot_age" : 0,
               "max_snapshot_attempts" : 0,
               "move_allocators" : [
                  null
               ],
               "move_instances" : [
                  null
               ],
               "move_only" : true,
               "override_failsafe" : true,
               "preferred_allocators" : [
                  "string"
               ],
               "reallocate_instances" : true,
               "skip_data_migration" : true,
               "skip_post_upgrade_steps" : true,
               "skip_snapshot" : true,
               "skip_upgrade_checker" : true,
               "timeout" : 0
            },
            "restore_snapshot" : {
               "repository_config" : {
                  "raw_settings" : {}
               },
               "repository_name" : "string",
               "restore_payload" : {
                  "indices" : [
                     "string"
                  ],
                  "raw_settings" : {}
               },
               "snapshot_name" : "string",
               "source_cluster_id" : "string",
               "strategy" : "string"
            },
            "strategy" : null
         },
         "cluster_id" : "string",
         "errors" : [
            null
         ]
      }
   ],
   "kibana_clusters" : [
      {
         "calculated_plan" : {
            "plan_configuration" : {
               "calm_wait_time" : 0,
               "cluster_reboot" : "string",
               "extended_maintenance" : true,
               "move_allocators" : [
                  null
               ],
               "move_instances" : [
                  null
               ],
               "preferred_allocators" : [
                  "string"
               ],
               "reallocate_instances" : true,
               "timeout" : 0
            },
            "strategy" : null
         },
         "cluster_id" : "string",
         "errors" : [
            null
         ]
      }
   ]
}

MoveClustersRequest

The request for moving Elasticsearch clusters off an allocator.

Properties

apm_clusters (array[MoveApmClusterConfiguration])
Optional list of Apm clusters to move off the allocator.
elasticsearch_clusters (array[MoveElasticsearchClusterConfiguration])
Optional list of Elasticsearch clusters to move off the allocator.
kibana_clusters (array[MoveKibanaClusterConfiguration])
Optional list of Kibana clusters to move off the allocator.

Example

{
   "apm_clusters" : [
      {
         "cluster_ids" : [
            "string"
         ],
         "plan_override" : {
            "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" : {
               "grow_and_shrink" : {},
               "rolling" : {
                  "allow_inline_resize" : true,
                  "group_by" : "string",
                  "shard_init_wait_time" : 0,
                  "skip_synced_flush" : true
               },
               "rolling_grow_and_shrink" : {}
            }
         }
      }
   ],
   "elasticsearch_clusters" : [
      {
         "cluster_ids" : [
            "string"
         ],
         "plan_override" : {
            "cluster_settings_json" : {},
            "plan_configuration" : {
               "calm_wait_time" : 0,
               "cluster_reboot" : "string",
               "extended_maintenance" : true,
               "max_snapshot_age" : 0,
               "max_snapshot_attempts" : 0,
               "move_allocators" : [
                  null
               ],
               "move_instances" : [
                  null
               ],
               "move_only" : true,
               "override_failsafe" : true,
               "preferred_allocators" : [
                  "string"
               ],
               "reallocate_instances" : true,
               "skip_data_migration" : true,
               "skip_post_upgrade_steps" : true,
               "skip_snapshot" : true,
               "skip_upgrade_checker" : true,
               "timeout" : 0
            },
            "restore_snapshot" : {
               "repository_config" : {
                  "raw_settings" : {}
               },
               "repository_name" : "string",
               "restore_payload" : {
                  "indices" : [
                     "string"
                  ],
                  "raw_settings" : {}
               },
               "snapshot_name" : "string",
               "source_cluster_id" : "string",
               "strategy" : "string"
            },
            "strategy" : null
         }
      }
   ],
   "kibana_clusters" : [
      {
         "cluster_ids" : [
            "string"
         ],
         "plan_override" : {
            "plan_configuration" : {
               "calm_wait_time" : 0,
               "cluster_reboot" : "string",
               "extended_maintenance" : true,
               "move_allocators" : [
                  null
               ],
               "move_instances" : [
                  null
               ],
               "preferred_allocators" : [
                  "string"
               ],
               "reallocate_instances" : true,
               "timeout" : 0
            },
            "strategy" : null
         }
      }
   ]
}

MoveElasticsearchClusterConfiguration

The configuration object for moving Elasticsearch clusters.

Properties

cluster_ids (array[string], required)
Identifiers for the Elasticsearch clusters.
plan_override (TransientElasticsearchPlanConfiguration)
Plan override to apply to the Elasticsearch clusters being moved.

Example

{
   "cluster_ids" : [
      "string"
   ],
   "plan_override" : {
      "cluster_settings_json" : {},
      "plan_configuration" : {
         "calm_wait_time" : 0,
         "cluster_reboot" : "string",
         "extended_maintenance" : true,
         "max_snapshot_age" : 0,
         "max_snapshot_attempts" : 0,
         "move_allocators" : [
            {
               "allocator_down" : true,
               "from" : "string",
               "to" : [
                  "string"
               ]
            }
         ],
         "move_instances" : [
            {
               "from" : "string",
               "instance_down" : true,
               "to" : [
                  "string"
               ]
            }
         ],
         "move_only" : true,
         "override_failsafe" : true,
         "preferred_allocators" : [
            "string"
         ],
         "reallocate_instances" : true,
         "skip_data_migration" : true,
         "skip_post_upgrade_steps" : true,
         "skip_snapshot" : true,
         "skip_upgrade_checker" : true,
         "timeout" : 0
      },
      "restore_snapshot" : {
         "repository_config" : {
            "raw_settings" : {}
         },
         "repository_name" : "string",
         "restore_payload" : {
            "indices" : [
               "string"
            ],
            "raw_settings" : {}
         },
         "snapshot_name" : "string",
         "source_cluster_id" : "string",
         "strategy" : "string"
      },
      "strategy" : {
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   }
}

MoveElasticsearchClusterDetails

Information about the Elasticsearch cluster that you want to move.

Properties

calculated_plan (TransientElasticsearchPlanConfiguration)
If only validating the move, then the plan configuration that would be applied to the cluster.
cluster_id (string, required)
Identifier for the Elasticsearch cluster.
errors (array[BasicFailedReplyElement])
A list of errors that occurred if the attempt to move the cluster failed.

Example

{
   "calculated_plan" : {
      "cluster_settings_json" : {},
      "plan_configuration" : {
         "calm_wait_time" : 0,
         "cluster_reboot" : "string",
         "extended_maintenance" : true,
         "max_snapshot_age" : 0,
         "max_snapshot_attempts" : 0,
         "move_allocators" : [
            {
               "allocator_down" : true,
               "from" : "string",
               "to" : [
                  "string"
               ]
            }
         ],
         "move_instances" : [
            {
               "from" : "string",
               "instance_down" : true,
               "to" : [
                  "string"
               ]
            }
         ],
         "move_only" : true,
         "override_failsafe" : true,
         "preferred_allocators" : [
            "string"
         ],
         "reallocate_instances" : true,
         "skip_data_migration" : true,
         "skip_post_upgrade_steps" : true,
         "skip_snapshot" : true,
         "skip_upgrade_checker" : true,
         "timeout" : 0
      },
      "restore_snapshot" : {
         "repository_config" : {
            "raw_settings" : {}
         },
         "repository_name" : "string",
         "restore_payload" : {
            "indices" : [
               "string"
            ],
            "raw_settings" : {}
         },
         "snapshot_name" : "string",
         "source_cluster_id" : "string",
         "strategy" : "string"
      },
      "strategy" : {
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   },
   "cluster_id" : "string",
   "errors" : [
      {
         "code" : "string",
         "fields" : [
            "string"
         ],
         "message" : "string"
      }
   ]
}

MoveKibanaClusterConfiguration

The configuration object for moving Kibana instances.

Properties

cluster_ids (array[string], required)
Identifiers for the Kibana clusters.
plan_override (TransientKibanaPlanConfiguration)
Plan override to apply to the Kibana clusters being moved.

Example

{
   "cluster_ids" : [
      "string"
   ],
   "plan_override" : {
      "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" : {
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   }
}

MoveKibanaClusterDetails

Information about the Kibana instance that you want to move.

Properties

calculated_plan (TransientKibanaPlanConfiguration)
If only validating the move, then the plan configuration that would be applied to the cluster.
cluster_id (string, required)
Identifier for the Kibana cluster.
errors (array[BasicFailedReplyElement])
A list of errors that occurred if the attempt to move the cluster failed.

Example

{
   "calculated_plan" : {
      "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" : {
         "grow_and_shrink" : {},
         "rolling" : {
            "allow_inline_resize" : true,
            "group_by" : "string",
            "shard_init_wait_time" : 0,
            "skip_synced_flush" : true
         },
         "rolling_grow_and_shrink" : {}
      }
   },
   "cluster_id" : "string",
   "errors" : [
      {
         "code" : "string",
         "fields" : [
            "string"
         ],
         "message" : "string"
      }
   ]
}

NestedQuery

A query that matches nested objects.

Properties

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

Example

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

NodeTypeResource

Information about the node type.

Properties

default_instance_configuration_id (string)
Id of the default instance configuration to use for this node type.
description (string, required)
Node type description
name (string, required)
Node type name
node_type (string, required)
Node type, part of the key for this resource

Example

{
   "default_instance_configuration_id" : "string",
   "description" : "string",
   "name" : "string",
   "node_type" : "string"
}

Note

Note

Properties

id (string)
note id
message (string, required)
Note message
timestamp (string as date-time)
Note last modification timestamp
user_id (string)
Note author

Example

{
   "id" : "string",
   "message" : "string",
   "timestamp" : "2019-01-01T00:00:00Z",
   "user_id" : "string"
}

Notes

User notes

Properties

notes (array[Note])
Notes

Example

{
   "notes" : [
      {
         "id" : "string",
         "message" : "string",
         "timestamp" : "2019-01-01T00:00:00Z",
         "user_id" : "string"
      }
   ]
}

PlanStrategy

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

Properties

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

Example

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

PlatformInfo

Information about the platform.

Properties

eula_accepted (boolean)
Indicates if the End User License Agreement been accepted
phone_home_enabled (boolean)
Is the phone-home service, which returns anonymized usage statistics to Elastic, enabled
services (array[PlatformServiceInfo])
version (string)
Platform version

Example

{
   "eula_accepted" : true,
   "phone_home_enabled" : true,
   "services" : [
      {
         "image" : [
            {
               "hash" : "string",
               "id" : "string",
               "tag" : "string",
               "version" : "string"
            }
         ],
         "type" : "string"
      }
   ],
   "version" : "string"
}

PlatformServiceImageInfo

The docker image that is used to run a service.

Properties

hash (string)
Image hash code

+ Example: "sha256:04a5be1ab07de64269ffa52da26044e0ecc36fa1164e7914468e69d65a2090d4"

id (string)
Id of runner that hosts the container

+ Example: "docker.elastic.co/elastic-cloud-enterprise:1.0.0-GA"

tag (string)
Image tag

+ Example: "docker.elastic.co/elastic-cloud-enterprise:1.0.0-GA"

version (string)
Version of service

+ Example: "1.0.0-GA"

Example

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

PlatformServiceInfo

The platform service information.

Properties

image (array[PlatformServiceImageInfo])
type (string)
Name of service

Example

{
   "image" : [
      {
         "hash" : "string",
         "id" : "string",
         "tag" : "string",
         "version" : "string"
      }
   ],
   "type" : "string"
}

PrefixQuery

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

Properties

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

Example

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

ProxiesAllocationsInfo

The allocation status for a specified type, such as Elasticsearch, Kibana, or APM. The status is part of the overall proxy health information.

Properties

allocations_type (string, required)
The type of proxy allocations (e.g. Elasticsearch, Kibana, APM)
max_allocations (integer as int32, required)
The maximum number of allocations
proxies_at_max_allocations (integer as int32, required)
The number of proxies that have the maximum number of allocations

Example

{
   "allocations_type" : "string",
   "max_allocations" : 0,
   "proxies_at_max_allocations" : 0
}

ProxiesFilter

Selects proxies by matching a proxy metadata item.

Properties

key (string, required)
Key of the proxy metadata item to be matched
value (string, required)
Value of the proxy metadata item to be matched

Example

{
   "key" : "string",
   "value" : "string"
}

ProxiesFilteredGroup

A set of proxy filters with an expected number of matching proxies.

Properties

expected_proxies_count (integer as int32, required)
Expected minimum number of proxies matching all filters in this group
filters (array[ProxiesFilter], required)
Filters to be matched
id (string)
Identifier of the filtered group of proxies

Example

{
   "expected_proxies_count" : 0,
   "filters" : [
      {
         "key" : "string",
         "value" : "string"
      }
   ],
   "id" : "string"
}

ProxiesFilteredGroupHealth

The health status of a filtered proxy group.

Properties

group (ProxiesFilteredGroup, required)
Settings of the filtered group
observed_proxies_count (integer as int32, required)
The number of proxies that match all of the filters in the group
status (string, required)
"Health status for this filtered group. One of "Green", "Yellow" or "Red"

Example

{
   "group" : {
      "expected_proxies_count" : 0,
      "filters" : [
         {
            "key" : "string",
            "value" : "string"
         }
      ],
      "id" : "string"
   },
   "observed_proxies_count" : 0,
   "status" : "string"
}

ProxiesHealth

Intentionally left blank

Properties

allocations (array[ProxiesAllocationsInfo], required)
Allocations for proxies
expected_proxies_count (integer as int32, required)
Expected minimum number of proxies
filtered_groups (array[ProxiesFilteredGroupHealth], required)
Filtered groups of proxies with associated status
observed_proxies_count (integer as int32, required)
Total number of proxies
status (string, required)
"Health status for all proxies. One of "Green", "Yellow" or "Red"

Example

{
   "allocations" : [
      {
         "allocations_type" : "string",
         "max_allocations" : 0,
         "proxies_at_max_allocations" : 0
      }
   ],
   "expected_proxies_count" : 0,
   "filtered_groups" : [
      {
         "group" : {
            "expected_proxies_count" : 0,
            "filters" : [
               {
                  "key" : "string",
                  "value" : "string"
               }
            ],
            "id" : "string"
         },
         "observed_proxies_count" : 0,
         "status" : "string"
      }
   ],
   "observed_proxies_count" : 0,
   "status" : "string"
}

ProxiesHttpSettings

The HTTP settings for all proxies.

Properties

cookie_secret (string, required)
Secret string for the HTTP cookie
dashboards_base_url (string, required)
Base URL for the dashboard
disconnected_cutoff (integer as int64, required)
Cutoff interval after disconnection in milliseconds
minimum_proxy_services (integer as int32, required)
Minimum number of proxy instances
sso_settings (ProxiesSSOSettings, required)
Settings related to single-sign-on
user_cookie_key (string, required)
User key for the HTTP cookie

Example

{
   "cookie_secret" : "string",
   "dashboards_base_url" : "string",
   "disconnected_cutoff" : 0,
   "minimum_proxy_services" : 0,
   "sso_settings" : {
      "cookie_name" : "string",
      "default_redirect_path" : "string",
      "dont_log_requests" : true,
      "maintenance_bypass_cookie_name" : "string",
      "max_age" : 0,
      "sso_secret" : "string"
   },
   "user_cookie_key" : "string"
}

ProxiesSSOSettings

The single sign-on settings for all proxies.

Properties

cookie_name (string, required)
Name of the HTTP cookie used for single-sign-on
default_redirect_path (string, required)
Default path where users are redirected after a successful single-sign-on
dont_log_requests (boolean, required)
If true, don't log requests
maintenance_bypass_cookie_name (string, required)
Name of the cookie that bypasses maintenance
max_age (integer as int64, required)
Maximum age of single-sign-on token in milliseconds
sso_secret (string, required)
Secret string for single-sign-on

Example

{
   "cookie_name" : "string",
   "default_redirect_path" : "string",
   "dont_log_requests" : true,
   "maintenance_bypass_cookie_name" : "string",
   "max_age" : 0,
   "sso_secret" : "string"
}

ProxiesSettings

The settings for all proxies.

Properties

expected_proxies_count (integer as int32, required)
Expected number of proxies
http_settings (ProxiesHttpSettings, required)
HTTP settings
signature_secret (string, required)
Secret string for signature generation
signature_valid_for_millis (integer as int64, required)
Signature validity in milliseconds

Example

{
   "expected_proxies_count" : 0,
   "http_settings" : {
      "cookie_secret" : "string",
      "dashboards_base_url" : "string",
      "disconnected_cutoff" : 0,
      "minimum_proxy_services" : 0,
      "sso_settings" : {
         "cookie_name" : "string",
         "default_redirect_path" : "string",
         "dont_log_requests" : true,
         "maintenance_bypass_cookie_name" : "string",
         "max_age" : 0,
         "sso_secret" : "string"
      },
      "user_cookie_key" : "string"
   },
   "signature_secret" : "string",
   "signature_valid_for_millis" : 0
}

ProxyAllocationCounts

The number of proxy allocations.

Properties

allocations (integer as int32, required)
The allocations count.
connectors (integer as int32, required)
The connector count.

Example

{
   "allocations" : 0,
   "connectors" : 0
}

ProxyAllocationInfo

The single proxy allocation for a specified type, such as Elasticsearch, Kibana, or APM.

Properties

allocations_type (string, required)
The type of proxy allocations (e.g. Elasticsearch, Kibana, APM)
counts (ProxyAllocationCounts, required)
Proxy allocation counts.

Example

{
   "allocations_type" : "string",
   "counts" : {
      "allocations" : 0,
      "connectors" : 0
   }
}

ProxyInfo

Information about a proxy.

Properties

allocations (array[ProxyAllocationInfo], required)
Allocation information by type.
healthy (boolean, required)
Specifies if the proxy is healthy
host_ip (string, required)
IP of the host the proxy runs on
metadata (object, required)
Arbitrary metadata associated with the proxy
proxy_id (string, required)
The proxy identifier
public_hostname (string, required)
Public hostname of the host the proxy runs on
runner_id (string)
Identifier of the runner for the proxy
zone (string)
The zone.

Example

{
   "allocations" : [
      {
         "allocations_type" : "string",
         "counts" : {
            "allocations" : 0,
            "connectors" : 0
         }
      }
   ],
   "healthy" : true,
   "host_ip" : "string",
   "metadata" : {},
   "proxy_id" : "string",
   "public_hostname" : "string",
   "runner_id" : "string",
   "zone" : "string"
}

ProxyOverview

Information about all of the proxies.

Properties

proxies (array[ProxyInfo], required)
Proxies
proxies_count (integer as int32, required)
Number of proxies
settings (ProxiesSettings, required)
Settings

Example

{
   "proxies" : [
      {
         "allocations" : [
            {
               "allocations_type" : "string",
               "counts" : {
                  "allocations" : 0,
                  "connectors" : 0
               }
            }
         ],
         "healthy" : true,
         "host_ip" : "string",
         "metadata" : {},
         "proxy_id" : "string",
         "public_hostname" : "string",
         "runner_id" : "string",
         "zone" : "string"
      }
   ],
   "proxies_count" : 0,
   "settings" : {
      "expected_proxies_count" : 0,
      "http_settings" : {
         "cookie_secret" : "string",
         "dashboards_base_url" : "string",
         "disconnected_cutoff" : 0,
         "minimum_proxy_services" : 0,
         "sso_settings" : {
            "cookie_name" : "string",
            "default_redirect_path" : "string",
            "dont_log_requests" : true,
            "maintenance_bypass_cookie_name" : "string",
            "max_age" : 0,
            "sso_secret" : "string"
         },
         "user_cookie_key" : "string"
      },
      "signature_secret" : "string",
      "signature_valid_for_millis" : 0
   }
}

QueryContainer

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

Properties

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

Example

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

QueryStringQuery

A query that uses the SimpleQueryParser for parsing.

Properties

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

Example

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

RangeQuery

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

Properties

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

Example

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

RemoteClusterInfo

Information about the remote cluster for cross-cluster search.

Properties

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

Example

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

RemoteClusterRef

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

Properties

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

Example

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

RepositoryConfig

The snapshot repository configuration.

Properties

config (object, required)
Elasticsearch configuration JSON for a snapshot repository
repository_name (string, required)
Elasticsearch snapshot repository name

Example

{
   "config" : {},
   "repository_name" : "string"
}

RepositoryConfigs

A list of snapshot repository configurations.

Properties

configs (array[RepositoryConfig])
List of snapshot configurations

Example

{
   "configs" : [
      {
         "config" : {},
         "repository_name" : "string"
      }
   ]
}

RequestEnrollmentTokenReply

Returns the enrollment token that is used to securely start a new server with designated roles.

Properties

token (string)
The requested token
token_id (string)
An identifier for the requested token (if persistent) that can be used in listing and deletion

Example

{
   "token" : "string",
   "token_id" : "string"
}

RestoreSnapshotApiConfiguration

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

Properties

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

Example

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

RestoreSnapshotConfiguration

Restores a snapshot from a local or remote repository.

Properties

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

Example

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

RestoreSnapshotRepoConfiguration

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

Properties

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

Example

{
   "raw_settings" : {}
}

RollingGrowShrinkStrategyConfig

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

Example

{}

RollingStrategyConfig

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

Properties

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

Example

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

RuleSetResponse

The response after you create a new ruleset.

Properties

id (string, required)
The new ruleset ID

Example

{
   "id" : "string"
}

RulesetAssociations

The configuration settings for IP filtering.

Properties

associations (array[FilterAssociation], required)
List of associations
total_associations (integer as int32)
Total number of associations. This includes associations user doesn't have permission to view.

Example

{
   "associations" : [
      {
         "entity_type" : "string",
         "id" : "string"
      }
   ],
   "total_associations" : 0
}

RunnerBuildInfo

Intentionally left blank

Properties

commit_hash (string)
Git commit hash
version (string)
Version of the runner artifact

Example

{
   "commit_hash" : "string",
   "version" : "string"
}

RunnerContainerInfo

Information about a container within a runner.

Properties

container_name (string, required)
Name of this container
container_set_name (string, required)
Name of the container set for the container

Example

{
   "container_name" : "string",
   "container_set_name" : "string"
}

RunnerInfo

Information about a specified runner.

Properties

build_info (RunnerBuildInfo)
Build Info of the container artifact
connected (boolean, required)
Specifies if the runner is connected
containers (array[RunnerContainerInfo], required)
Containers for the runner
features (map[string,boolean])
State of features of the runner
healthy (boolean, required)
Specifies if the runner is healthy
host_ip (string, required)
Host IP for the runner
public_hostname (string, required)
Public hostname for the runner
roles (array[RunnerRoleInfo], required)
Roles for the runner
runner_id (string, required)
The runner identifier
runner_name (string)
The runner name
tags (map[string,string])
Meta data of the runner, like image ID or processor architecture
zone (string)
Identifier of the zone

Example

{
   "build_info" : {
      "commit_hash" : "string",
      "version" : "string"
   },
   "connected" : true,
   "containers" : [
      {
         "container_name" : "string",
         "container_set_name" : "string"
      }
   ],
   "features" : {
      "some_property" : true
   },
   "healthy" : true,
   "host_ip" : "string",
   "public_hostname" : "string",
   "roles" : [
      {
         "role_name" : "string"
      }
   ],
   "runner_id" : "string",
   "runner_name" : "string",
   "tags" : {
      "some_property" : "string"
   },
   "zone" : "string"
}

RunnerOverview

Information about all of the runners.

Properties

runners (array[RunnerInfo], required)
List of runners

Example

{
   "runners" : [
      {
         "build_info" : {
            "commit_hash" : "string",
            "version" : "string"
         },
         "connected" : true,
         "containers" : [
            {
               "container_name" : "string",
               "container_set_name" : "string"
            }
         ],
         "features" : {
            "some_property" : true
         },
         "healthy" : true,
         "host_ip" : "string",
         "public_hostname" : "string",
         "roles" : [
            {
               "role_name" : "string"
            }
         ],
         "runner_id" : "string",
         "runner_name" : "string",
         "tags" : {
            "some_property" : "string"
         },
         "zone" : "string"
      }
   ]
}

RunnerRoleInfo

Information about a runner role.

Properties

role_name (string, required)
Name of the role

Example

{
   "role_name" : "string"
}

RunnerRolesInfo

A list of runner roles.

Properties

roles (array[RunnerRoleInfo], required)
List of roles

Example

{
   "roles" : [
      {
         "role_name" : "string"
      }
   ]
}

SamlAttributeSettings

The mapping configuration for the Elasticsearch security SAML attribute.

Properties

dn (string)
The Name of the SAML attribute that contains the user's X.50 Distinguished Name
groups (string, required)
The Name of the SAML attribute that contains the user's groups
mail (string)
The Name of the SAML attribute that contains the user's email address
name (string)
The Name of the SAML attribute that contains the user's full name
principal (string, required)
The Name of the SAML attribute that contains the user's principal (username)

Example

{
   "dn" : "string",
   "groups" : "string",
   "mail" : "string",
   "name" : "string",
   "principal" : "string"
}

SamlIdpSettings

The configuration for the Elasticsearch security SAML Identity Provider.

Properties

entity_id (string, required)
The Entity ID of the SAML Identity Provider. An Entity ID is a URI with a maximum length of 1024 characters. It can be a URL or a URN and can be found in the configuration or the SAML metadata of the Identity Provider.
metadata_path (string, required)
The URL to a SAML 2.0 metadata file describing the capabilities and configuration of the Identity Provider
use_single_logout (boolean)
Indicates whether to utilise the Identity Provider's Single Logout service

Example

{
   "entity_id" : "string",
   "metadata_path" : "string",
   "use_single_logout" : true
}

SamlSecurityRealmRoleMappingRule

The mapping rule for the Elasticsearch security SAML role.

Properties

roles (array[string], required)
The roles that are applied when the mapping rule is successfully evaluated
type (string; allowed values: [username, groups, dn], required)
The type of role mapping rule
value (string, required)
The value to match when evaluating this rule

Example

{
   "roles" : [
      "string"
   ],
   "type" : "string",
   "value" : "string"
}

SamlSecurityRealmRoleMappingRules

The mapping ruleset for the Elasticsearch security SAML role.

Properties

default_roles (array[string], required)
The default roles applied to all users
rules (array[SamlSecurityRealmRoleMappingRule], required)
The role mapping rules to evaluate

Example

{
   "default_roles" : [
      "string"
   ],
   "rules" : [
      {
         "roles" : [
            "string"
         ],
         "type" : "string",
         "value" : "string"
      }
   ]
}

SamlSettings

The configuration for the Elasticsearch security SAML realm.

Properties

attributes (SamlAttributeSettings, required)
The SAML attribute mapping configuration
enabled (boolean)
When true, enables the security realm
encryption_certificate_url (string)
The SAML encryption certificate bundle URL. The bundle should be a zip file containing 'encryption.key' and 'encryption.pem' files in the directory '/saml/:id', where :id is the value of the [id] field.
encryption_certificate_url_password (string)
The password to the encryption certificate bundle
force_authn (boolean)
Specifies whether to set the ForceAuthn attribute when requesting that the IdP authenticate the current user. If set to true, the IdP is required to verify the user's identity, irrespective of any existing sessions they might have.
id (string, required)
The identifier for the security realm
idp (SamlIdpSettings, required)
The SAML Identity Provider configuration
name (string, required)
The friendly name of the security realm
order (integer as int32)
The order that the security realm is evaluated
override_yaml (string)
Advanced configuration options in YAML format. Any settings defined here will override any configuration set via the API.
role_mappings (SamlSecurityRealmRoleMappingRules)
The role mapping rules associated with the security realm
signing_certificate_url (string)
The SAML signing certificate bundle URL. The bundle should be a zip file containing 'signing.key' and 'signing.pem' files in the directory '/saml/:id', where :id is the value of the [id] field.
signing_certificate_url_password (string)
The password to the signing certificate bundle
signing_saml_messages (array[string])
A list of SAML message types that should be signed. Each element in the list should be the local name of a SAML XML Element. Supported element types are AuthnRequest, LogoutRequest and LogoutResponse. Only valid if a signing certificate is also specified.
sp (SamlSpSettings, required)
The SAML Service Provider configuration
ssl_certificate_url (string)
The SSL trusted CA certificate bundle URL. The bundle should be a zip file containing a single keystore file 'keystore.ks' in the directory '/saml/:id/truststore', where :id is the value of the [id] field.
ssl_certificate_url_truststore_password (string)
The password to the SSL certificate bundle URL truststore
ssl_certificate_url_truststore_type (string; allowed values: [jks, PKCS12])
The format of the keystore file. Should be jks to use the Java Keystore format or PKCS12 to use PKCS#12 files. The default is jks.

Example

{
   "attributes" : {
      "dn" : "string",
      "groups" : "string",
      "mail" : "string",
      "name" : "string",
      "principal" : "string"
   },
   "enabled" : true,
   "encryption_certificate_url" : "string",
   "encryption_certificate_url_password" : "string",
   "force_authn" : true,
   "id" : "string",
   "idp" : {
      "entity_id" : "string",
      "metadata_path" : "string",
      "use_single_logout" : true
   },
   "name" : "string",
   "order" : 0,
   "override_yaml" : "string",
   "role_mappings" : {
      "default_roles" : [
         "string"
      ],
      "rules" : [
         {
            "roles" : [
               "string"
            ],
            "type" : "string",
            "value" : "string"
         }
      ]
   },
   "signing_certificate_url" : "string",
   "signing_certificate_url_password" : "string",
   "signing_saml_messages" : [
      "string"
   ],
   "sp" : {
      "acs" : "string",
      "entity_id" : "string",
      "logout" : "string"
   },
   "ssl_certificate_url" : "string",
   "ssl_certificate_url_truststore_password" : "string",
   "ssl_certificate_url_truststore_type" : "string"
}

SamlSpSettings

The configuration for the Elasticsearch security SAML Service Provider.

Properties

acs (string, required)
The URL of the Assertion Consumer service
entity_id (string, required)
The Entity ID to use for this SAML Service Provider. This should be entered as a URI.
logout (string, required)
The URL of the Single Logout service

Example

{
   "acs" : "string",
   "entity_id" : "string",
   "logout" : "string"
}

SearchRequest

An Elasticsearch search request with a subset of options.

Properties

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

Example

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

SecurityDeployment

The Elasticsearch security deployment.

Properties

cluster_id (string, required)
The identifier for the security deployment cluster
has_pending_plan (boolean, required)
True if a pending plan is in progress
is_enabled (boolean, required)
True if the security cluster is currently enabled
is_healthy (boolean, required)
True if the cluster is healthy
name (string, required)
The name of the security deployment cluster
status (string; allowed values: [initializing, stopping, stopped, rebooting, restarting, reconfiguring, started], required)
The current status of the cluster
version (string)
The version of the Elasticsearch cluster

Example

{
   "cluster_id" : "string",
   "has_pending_plan" : true,
   "is_enabled" : true,
   "is_healthy" : true,
   "name" : "string",
   "status" : "string",
   "version" : "string"
}

SecurityDeploymentCreateRequest

The creation request for the Elasticsearch security deployment.

Properties

name (string)
The name of the security deployment cluster
topology (SecurityDeploymentTopology)
The cluster topology used to create the security deployment cluster
version (string)
The version of the Elasticsearch cluster

Example

{
   "name" : "string",
   "topology" : {
      "size" : {
         "resource" : "string",
         "value" : 0
      },
      "zone_count" : 0
   },
   "version" : "string"
}

SecurityDeploymentTopology

The cluster topology for the Elasticsearch security deployment.

Properties

size (TopologySize)
The security deployment topology size
zone_count (integer as int32)
The default number of zones in which data nodes will be placed

Example

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

SecurityRealmInfo

The overview for the Elasticsearch security realm.

Properties

enabled (boolean)
True if the security realm is enabled
id (string, required)
The identifier for the security realm
name (string, required)
The friendly name of the security realm
order (integer as int32)
The order the security realm should be evaluated
type (string; allowed values: [native, ldap, saml], required)
The type of the security realm
urls (array[string], required)
The URLs associated with the security realm

Example

{
   "enabled" : true,
   "id" : "string",
   "name" : "string",
   "order" : 0,
   "type" : "string",
   "urls" : [
      "string"
   ]
}

SecurityRealmInfoList

A list of Elasticsearch security realms.

Properties

realms (array[SecurityRealmInfo], required)
The list of security realms

Example

{
   "realms" : [
      {
         "enabled" : true,
         "id" : "string",
         "name" : "string",
         "order" : 0,
         "type" : "string",
         "urls" : [
            "string"
         ]
      }
   ]
}

SecurityRealmsReorderRequest

A reorder request for Elasticsearch security realms.

Properties

realms (array[string], required)
The list of security realms in the desired order

Example

{
   "realms" : [
      "string"
   ]
}

SnapshotRepositoryConfiguration

The configuration for an Elasticsearch snapshot repository.

Properties

settings (object, required)
Elasticsearch repository configuration settings JSON. See Elasticsearch documentation for more information
type (string, required)
Repository type, (Currently supported: 's3')

Example

{
   "settings" : {},
   "type" : "string"
}

SnapshotStatusInfo

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

Properties

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

Example

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

StackVersionApmConfig

The APM Server configuration for an Elastic Stack version.

Properties

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

Example

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

StackVersionArchiveProcessingError

Information about the errors that occurred from processing an Elastic Stack version.

Properties

errors (BasicFailedReply)
stack_version (string)
Version of the stack (ie directory name in archive root)

Example

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

StackVersionArchiveProcessingResult

The result from processing an archive of an Elastic Stack version.

Properties

errors (array[StackVersionArchiveProcessingError])
Errors occurred while processing the Elastic Stack pack. Key: stack version, Value: List of errors
stacks (array[StackVersionConfig])

Example

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

StackVersionConfig

The details for an Elastic Stack configuration.

Properties

accessible (boolean)
Whether or not this version is accessible by the calling user. This is only relevant in EC (SaaS) and is not sent in ECE.
apm (StackVersionApmConfig)
The APM Server configuration for an Elastic Stack version.
deleted (boolean)
Identifies that the Elastic Stack version is marked for deletion
elasticsearch (StackVersionElasticsearchConfig)
The Elasticsearch configuration for an Elastic Stack version.
kibana (StackVersionKibanaConfig)
The Kibana configuration for an Elastic Stack version.
metadata (StackVersionMetadata)
The metadata for the Elastic Stack.
template (StackVersionTemplateInfo)
The template information for an Elastic Stack version.
upgradable_to (array[string])
Stack Versions that this version can upgrade to
version (string)
Stack version
whitelisted (boolean)
Whether or not this version is whitelisted. This is only relevant in EC (SaaS) and is not sent in ECE.

Example

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

StackVersionConfigPost

The configuration for an Elastic Stack version.

Properties

apm (StackVersionApmConfig)
The APM Server configuration for an Elastic Stack version.
elasticsearch (StackVersionElasticsearchConfig)
The Elasticsearch configuration for an Elastic Stack version.
kibana (StackVersionKibanaConfig)
The Kibana configuration for an Elastic Stack version.
metadata (StackVersionMetadata)
The metadata for the Elastic Stack.

Example

{
   "apm" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : {
         "max" : 0,
         "min" : 0
      },
      "compatible_node_types" : [
         "string"
      ],
      "docker_image" : "string",
      "settings" : {},
      "version" : "string"
   },
   "elasticsearch" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : null,
      "compatible_node_types" : [
         "string"
      ],
      "default_plugins" : [
         "string"
      ],
      "docker_image" : "string",
      "node_types" : [
         {
            "capacity_constraints" : null,
            "compatible_node_types" : [
               "string"
            ],
            "description" : "string",
            "name" : "string",
            "node_type" : "string",
            "settings" : {}
         }
      ],
      "plugins" : [
         "string"
      ],
      "settings" : {}
   },
   "kibana" : {
      "blacklist" : [
         "string"
      ],
      "capacity_constraints" : null,
      "compatible_node_types" : [
         "string"
      ],
      "docker_image" : "string",
      "settings" : {},
      "version" : "string"
   },
   "metadata" : {
      "min_platform_version" : "string",
      "notes" : "string",
      "pre_release" : true,
      "schema_version" : 0
   }
}

StackVersionConfigs

The details for multiple Elastic Stack configurations.

Properties

stacks (array[StackVersionConfig], required)

Example

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

StackVersionElasticsearchConfig

The Elasticsearch configuration for an Elastic Stack version.

Properties

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

Example

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

StackVersionInstanceCapacityConstraint

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

Properties

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

Example

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

StackVersionKibanaConfig

The Kibana configuration for an Elastic Stack version.

Properties

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

Example

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

StackVersionMetadata

The metadata for the Elastic Stack.

Properties

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

Example

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

StackVersionNodeType

The configuration for an Elastic Stack node type.

Properties

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

Example

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

StackVersionTemplateFileHash

The template file hash for an Elastic Stack version.

Properties

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

Example

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

StackVersionTemplateInfo

The template information for an Elastic Stack version.

Properties

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

Example

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

TargetElasticsearchCluster

Information about the specified Elasticsearch cluster.

Properties

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

Example

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

TermQuery

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

Properties

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

Example

{
   "value" : {}
}

TiebreakerTopologyElement

Defines the topology, such as capacity and location, of the special tiebreaker node. TIP: When there are master nodes present, the master node topology is the default.

Properties

memory_per_node (integer as int32, required)
The memory capacity in MB for the tiebreaker node.

Example

{
   "memory_per_node" : 0
}

TlsPublicCertChain

The public portion of the certificate chain that contains the PEM encoded server certificate, intermediate certificates, and the CA certificate. NOTE: The private key, normally included in certificate chains, is omitted.

Properties

chain (array[string], required)
The list of PEM encoded X509 certificates that make up the certificate chain
user_supplied (boolean, required)
Was this certificate chain user supplied or automatically generated?

Example

{
   "chain" : [
      "string"
   ],
   "user_supplied" : true
}

TokenResponse

The response value after a login without redirect configured, or after elevated permissions are enabled or disabled.

Properties

token (string, required)
The authorization bearer token that you use in subsequent requests

Example

{
   "token" : "string"
}

TopologySize

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

Properties

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

Example

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

TransientApmPlanConfiguration

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

Properties

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

Example

{
   "plan_configuration" : {
      "calm_wait_time" : 0,
      "cluster_reboot" : "string",
      "extended_maintenance" : true,
      "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" : {
      "grow_and_shrink" : {},
      "rolling" : {
         "allow_inline_resize" : true,
         "group_by" : "string",
         "shard_init_wait_time" : 0,
         "skip_synced_flush" : true
      },
      "rolling_grow_and_shrink" : {}
   }
}

TransientElasticsearchPlanConfiguration

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

Properties

cluster_settings_json (object)

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

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

Example

{
   "cluster_settings_json" : {},
   "plan_configuration" : {
      "calm_wait_time" : 0,
      "cluster_reboot" : "string",
      "extended_maintenance" : true,
      "max_snapshot_age" : 0,
      "max_snapshot_attempts" : 0,
      "move_allocators" : [
         {
            "allocator_down" : true,
            "from" : "string",
            "to" : [
               "string"
            ]
         }
      ],
      "move_instances" : [
         {
            "from" : "string",
            "instance_down" : true,
            "to" : [
               "string"
            ]
         }
      ],
      "move_only" : true,
      "override_failsafe" : true,
      "preferred_allocators" : [
         "string"
      ],
      "reallocate_instances" : true,
      "skip_data_migration" : true,
      "skip_post_upgrade_steps" : true,
      "skip_snapshot" : true,
      "skip_upgrade_checker" : true,
      "timeout" : 0
   },
   "restore_snapshot" : {
      "repository_config" : {
         "raw_settings" : {}
      },
      "repository_name" : "string",
      "restore_payload" : {
         "indices" : [
            "string"
         ],
         "raw_settings" : {}
      },
      "snapshot_name" : "string",
      "source_cluster_id" : "string",
      "strategy" : "string"
   },
   "strategy" : {
      "grow_and_shrink" : {},
      "rolling" : {
         "allow_inline_resize" : true,
         "group_by" : "string",
         "shard_init_wait_time" : 0,
         "skip_synced_flush" : true
      },
      "rolling_grow_and_shrink" : {}
   }
}

TransientKibanaPlanConfiguration

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

Properties

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

Example

{
   "plan_configuration" : {
      "calm_wait_time" : 0,
      "cluster_reboot" : "string",
      "extended_maintenance" : true,
      "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" : {
      "grow_and_shrink" : {},
      "rolling" : {
         "allow_inline_resize" : true,
         "group_by" : "string",
         "shard_init_wait_time" : 0,
         "skip_synced_flush" : true
      },
      "rolling_grow_and_shrink" : {}
   }
}

UsageStats

Information about the current usage.

Properties

total_connected_memory_total (integer as int32, required)
The total amount of memory available to your system

Example

{
   "total_connected_memory_total" : 0
}