Definitions

AllocatedInstanceStatus

Status for an allocated instance

Properties

cluster_healthy (boolean)
Indicates whether the cluster the instance belongs to is healthy
cluster_id (string)
Identifier for the cluster this instance belongs
cluster_name (string)
Name of cluster this instance belongs, if available
cluster_type (string)
Type of instance that is running. E.g. elasticsearch, kibana
healthy (boolean)
Indicates whether the instance is healthy
instance_name (string)
Instance ID of the instance
node_memory (integer as int32)
Memory assigned to this instance

Example

{
   "cluster_healthy" : true,
   "cluster_id" : "string",
   "cluster_name" : "string",
   "cluster_type" : "string",
   "healthy" : true,
   "instance_name" : "string",
   "node_memory" : 0
}

AllocatorCapacity

The current total and used capacity for this allocator

Properties

memory (AllocatorCapacityMemory)
Current view of the available and used memory of this allocator

Example

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

AllocatorCapacityMemory

Current view of the available and used memory of this allocator

Properties

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

Example

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

AllocatorHealthStatus

Status of this allocator

Properties

connected (boolean)
Whether the allocator is connected
healthy (boolean)
Whether the allocator is healthy, meaning it is either connected or has no instances
maintenance_mode (boolean)
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

Information about a given allocator

Properties

allocator_id (string)
Identifier for this allocator
capacity (AllocatorCapacity)
The current total and used capacity for this 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)
Host IP of this allocator
instances (array[AllocatedInstanceStatus])
metadata (array[MetadataItem])
Arbitrary metadata associated with this allocator
public_hostname (string)
Public hostname of this allocator
region (string)
The region that this allocator belongs to. Only populated in SaaS or federated ECE.
settings (AllocatorSettings)
An Allocators settings
status (AllocatorHealthStatus)
Status of this allocator
zone_id (string)
Identifier of the zone

Example

{
   "allocator_id" : "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_name" : "string",
         "node_memory" : 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

Requests that any instances on the specified allocators be moved to (optionally specified) different allocators as part of the upgrade plan

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

Overview over all installed allocators

Properties

zones (array[AllocatorZoneInfo])

Example

{
   "zones" : [
      {
         "allocators" : [
            {
               "allocator_id" : "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_name" : "string",
                     "node_memory" : 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

An Allocators settings

Properties

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

Example

{
   "capacity" : 0
}

AllocatorZoneInfo

List of allocators in a zone

Properties

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

Example

{
   "allocators" : [
      {
         "allocator_id" : "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_name" : "string",
               "node_memory" : 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

Intentionally left blank

Properties

docker_image (string)
A docker URI that allows overriding of the default docker image specified for this version
system_settings (ApmSystemSettings)
This structure defines a curated subset of the Apm settings that are of particular relevance to ECE. (This field together with 'user_settings_override_' and 'user_settings_' defines the total set of APM 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 top level info object for APM

Properties

elasticsearch_cluster (TargetElasticsearchCluster, required)
Information about the associated 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)
The cluster metadata stores a combination of public and internal state and configuration for a cluster. The unstructured content is undocumented unless explicitly stated elsewhere in the docs
name (string, required)
The name of the APM
plan_info (ApmPlansInfo, required)
Information about the current, pending, and past plans of an APM
region (string)
The region that this APM belongs to. Only populated in SaaS or federated ECE.
status (string; allowed values: [initializing, stopping, stopped, rebooting, restarting, reconfiguring, started])
APM status
topology (ClusterTopologyInfo, required)
A description of the cluster topology (the different instances/containers making up the cluster, 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",
   "status" : "string",
   "topology" : {
      "healthy" : true,
      "instances" : [
         {
            "allocator_id" : "string",
            "container_started" : true,
            "disk" : {
               "disk_space_available" : 0,
               "disk_space_used" : 0
            },
            "healthy" : true,
            "instance_configuration" : {
               "id" : "string",
               "name" : "string",
               "resource" : "string"
            },
            "instance_name" : "string",
            "maintenance_mode" : true,
            "memory" : {
               "instance_capacity" : 0,
               "memory_pressure" : 0,
               "native_memory_pressure" : 0
            },
            "service_id" : "string",
            "service_roles" : [
               "string"
            ],
            "service_running" : true,
            "service_version" : "string",
            "zone" : "string"
         }
      ]
   }
}

ApmPlan

Intentionally left blank

Properties

apm (ApmConfiguration, required)
cluster_topology (array[ApmTopologyElement])
transient (TransientApmPlanConfiguration)
Defines configuration parameters that control how the plan (ie consisting of the cluster topology and Apm settings) is applied

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

Intentionally left blank

Properties

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

Example

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

ApmPlanInfo

Information about a current, pending, or past 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)
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 the current, pending, and past plans of an APM

Properties

current (ApmPlanInfo)
Information about a current, pending, or past 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 a current, pending, or past 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
}

ApmSubInfo

Information about any APM clusters associated with this 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

This structure defines a curated subset of the Apm settings that are of particular relevance to ECE. (This field together with 'user_settings_override_' and 'user_settings_' defines the total set of APM 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 nodes (eg number/capacity of nodes, and where they can be allocated)

Properties

apm (ApmConfiguration)
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)
The size of a topology measured by the amount of some resource. The final cluster size is calculated using multipliers from the topology's 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 on a set of the APMs

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",
         "status" : "string",
         "topology" : {
            "healthy" : true,
            "instances" : [
               {
                  "allocator_id" : "string",
                  "container_started" : true,
                  "disk" : {
                     "disk_space_available" : 0,
                     "disk_space_used" : 0
                  },
                  "healthy" : true,
                  "instance_configuration" : {
                     "id" : "string",
                     "name" : "string",
                     "resource" : "string"
                  },
                  "instance_name" : "string",
                  "maintenance_mode" : true,
                  "memory" : {
                     "instance_capacity" : 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

Available authentication methods. Indicates what authentication methods are enabled on the authentication Elasticsearch cluster. If all fields are false, only reserved users (admin, readonly) 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 that matches documents matching 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" : {},
         "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

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 or Kibana cluster 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_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/password of the newly created cluster (returned from Elasticsearch cluster creates)

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 or Kibana 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/password of the newly created cluster (returned from Elasticsearch cluster creates)
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

Cluster index curation settings

Properties

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

Example

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

ClusterCurationSpec

Specifies the conditions for a curation trigger

Properties

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

Example

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

ClusterInstanceConfigurationInfo

Information about a configuration used to create an instance.

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 instance's storage capacity and use

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

Example

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

ClusterInstanceInfo

Information about each instance in a 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 instance's storage capacity and use
healthy (boolean, required)
Whether the instance is healthy (ie started and running)
instance_configuration (ClusterInstanceConfigurationInfo)
Information about a configuration used to create an instance.
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 instance's memory capacity and use
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
   },
   "healthy" : true,
   "instance_configuration" : {
      "id" : "string",
      "name" : "string",
      "resource" : "string"
   },
   "instance_name" : "string",
   "maintenance_mode" : true,
   "memory" : {
      "instance_capacity" : 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 instance's memory capacity and use

Properties

instance_capacity (integer as int32, required)
The memory capacity in MB of the instance
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,
   "memory_pressure" : 0,
   "native_memory_pressure" : 0
}

ClusterLicenseInfo

Information about a cluster license

Properties

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

Example

{
   "license" : {}
}

ClusterMetadataCpuResourcesSettings

The cluster metadata cpu resource settings stores settings related to cpu.

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

The cluster metadata stores a combination of public and internal state and configuration for a cluster. The unstructured content is undocumented unless explicitly stated elsewhere in the docs

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

Stores information about the ports that allow communication between the 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 cluster metadata resource settings stores top level configuration about cluster resources.

Properties

cpu (ClusterMetadataCpuResourcesSettings)
The cluster metadata cpu resource settings stores settings related to cpu.

Example

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

ClusterMetadataSettings

The cluster metadata settings stores top level configuration for a 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 cluster metadata resource settings stores top level configuration about 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
}

ClusterPlanStepInfo

A log of information each step taken during a plan attempt

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

One log message occurring during a given stage of a step

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 cluster snapshot repository default object.

Example

{}

ClusterSnapshotRepositoryInfo

The cluster snapshot repository information.

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 cluster snapshot repository reference object.

Properties

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

Example

{
   "repository_name" : "string"
}

ClusterSnapshotRepositoryStatic

The cluster snapshot repository static object.

Properties

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

Example

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

ClusterSnapshotRequest

Request settings when executing 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

Response value after successfully creating a new snapshot

Properties

name (string)
The name of the newly created snapshot

Example

{
   "name" : "string"
}

ClusterSnapshotRetention

The cluster snapshot retention information.

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 cluster snapshot settings stores snapshot configuration for a 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 that has happened on a 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

A description of the cluster topology (the different instances/containers making up the cluster, 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
         },
         "healthy" : true,
         "instance_configuration" : {
            "id" : "string",
            "name" : "string",
            "resource" : "string"
         },
         "instance_name" : "string",
         "maintenance_mode" : true,
         "memory" : {
            "instance_capacity" : 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 a 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"
}

CompatibleNodeTypesResource

Compatible node type information

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

Compatible version information

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

ConstructorHealthStatus

Status of this 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 a given constructor

Properties

constructor_id (string)
Identifier for this constructor
status (ConstructorHealthStatus)
Status of this constructor

Example

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

ConstructorOverview

Overview over all installed constructors

Properties

constructors (array[ConstructorInfo])

Example

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

CreateApmInCreateElasticsearchRequest

The body of a request to create a new APM as part of an Elasticearch cluster creation request

Properties

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

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 body of a request to create a new Apm cluster

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)

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 body of a request to create a new cluster

Properties

apm (CreateApmInCreateElasticsearchRequest)
The body of a request to create a new APM as part of an Elasticearch cluster creation request
cluster_name (string)
The human readable name for the cluster (defaults to the generated cluster id if not specified)
kibana (CreateKibanaInCreateElasticsearchRequest)
The body of a request to create a new Kibana cluster as part of an Elasticearch cluster creation request
plan (ElasticsearchClusterPlan, required)
The plan that defines the cluster
settings (ElasticsearchClusterSettings)
Settings for controlling ECE functionality 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_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" : {
      "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 body of a request to create a new Kibana cluster as part of an Elasticearch cluster creation request

Properties

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

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 body of a request to create a new Kibana cluster

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)

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

Cross-cluster search clusters for the remote cluster

Properties

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

Example

{
   "ccs_clusters" : [
      "string"
   ]
}

CrossClusterSearchSettings

Configuration settings for 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.
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_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" : {
         "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",
   "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" : {},
            "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

Documents which deployment template was used in the creation of this 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

Numerics representing possible instance sizes that the instance configuration supports.

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

Provides detailed information about an issue and the instances 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

Information about issues that prevent either whole cluster or a particular index from operating correctly

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 top level info object for an Elasticsearch cluster

Properties

associated_apm_clusters (array[ApmSubInfo], required)
associated_kibana_clusters (array[KibanaSubClusterInfo], required)
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 (indices, masters)
elasticsearch_monitoring_info (ElasticsearchMonitoringInfo)
Information about this cluster's ECE-managed XPack Monitoring status
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)
The cluster metadata stores a combination of public and internal state and configuration for a cluster. The unstructured content is undocumented unless explicitly stated elsewhere in the docs
plan_info (ElasticsearchClusterPlansInfo, required)
Information about the current, pending, and past plans of a cluster
region (string)
The region that this cluster belongs to. Only populated in SaaS or federated ECE.
security (ElasticsearchClusterSecurityInfo)
For 2.x clusters, information about the users and roles. For 5.x, the Kibana management UI should be used
settings (ElasticsearchClusterSettings)
Settings for controlling ECE functionality for an Elasticsearch cluster
snapshots (SnapshotStatusInfo, required)
Information about this cluster's snapshot status (health, etc.)
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)
A description of the cluster topology (the different instances/containers making up the cluster, 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
         }
      }
   ],
   "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
   },
   "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_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" : {
      "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
            },
            "healthy" : true,
            "instance_configuration" : {
               "id" : "string",
               "name" : "string",
               "resource" : "string"
            },
            "instance_name" : "string",
            "maintenance_mode" : true,
            "memory" : {
               "instance_capacity" : 0,
               "memory_pressure" : 0,
               "native_memory_pressure" : 0
            },
            "service_id" : "string",
            "service_roles" : [
               "string"
            ],
            "service_running" : true,
            "service_version" : "string",
            "zone" : "string"
         }
      ]
   }
}

ElasticsearchClusterInstanceSettingsOverrides

Elasticsearch instance settings overrides

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 that defines the 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)
Defines the Elasticsearch cluster settings. (If specified at the top level provides a field-by-field default; at the topology level provides the overrides)
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 configuration parameters that control how the plan (ie consisting of the cluster topology and Elasticsearch settings) is applied
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_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 a current, pending, or past 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 that defines the 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_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 plans of a cluster

Properties

current (ElasticsearchClusterPlanInfo)
Information about a current, pending, or past 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 a current, pending, or past 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_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

A list of users together with that user's roles

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 clusters, information about the users and roles. For 5.x, the Kibana management UI should be used

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

Settings for controlling ECE functionality for an Elasticsearch cluster

Properties

curation (ClusterCurationSettings)
Cluster index curation settings
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 cluster metadata settings stores top level configuration for a cluster.
monitoring (ManagedMonitoringSettings)
Settings for sending monitoring information to another cluster
snapshot (ClusterSnapshotSettings)
The cluster snapshot settings stores snapshot configuration for a cluster.

Example

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

Defines the topology of the Elasticsearch nodes (eg number/capacity/types 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)
Defines the Elasticsearch cluster settings. (If specified at the top level provides a field-by-field default; at the topology level provides the overrides)
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 different Elasticsearch node types (default: can be master, can hold data, can run ingest pipelines). (Cannot be set for tiebreaker topologies)
size (TopologySize)
The size of a topology measured by the amount of some resource. The final cluster size is calculated using multipliers from the topology's 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

A list of users together with their password hash

Properties

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

Example

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

ElasticsearchClustersInfo

A container for information about on a set of the 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
               }
            }
         ],
         "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
         },
         "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_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" : {
            "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
                  },
                  "healthy" : true,
                  "instance_configuration" : {
                     "id" : "string",
                     "name" : "string",
                     "resource" : "string"
                  },
                  "instance_name" : "string",
                  "maintenance_mode" : true,
                  "memory" : {
                     "instance_capacity" : 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

Defines the Elasticsearch cluster settings. (If specified at the top level provides a field-by-field default; at the topology level provides the overrides)

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)
This structure defines a curated subset of the Elasticsearch settings that are of particular relevance to ECE. (This field together with 'user_settings_override_' and 'user_settings_' defines the total set of Elasticsearch 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

This structure defines the index curation routing settings

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 (indices, masters)

Properties

blocking_issues (ElasticsearchClusterBlockingIssues)
Information about issues that prevent either whole cluster or a particular index from operating correctly
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 node(s) 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

More detailed information about which instances are port the cluster (or sub-clusters in the case of split brain)

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 node(s) 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 this cluster's ECE-managed XPack Monitoring status

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 different Elasticsearch node types (default: can be master, can hold data, can run ingest pipelines). (Cannot be 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

Fine grained control over various 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_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_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 - unlike with shards, unavailable replicas means 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

Scripts can be stored in indexes ('stored'), or uploaded in file bundles ('file'), or used directly in API requests ('inline'). This object controls whether scripting is enabled for the given type, together with other fine grained control parameters.

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 different 'languages' (painless/mustache/expressions) supported by the Elasticsearch cluster, and the different ways they can be used (file, index, inline). More complex configurations need to be handled by leaving these blank and controlling instead 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)
Scripts can be stored in indexes ('stored'), or uploaded in file bundles ('file'), or used directly in API requests ('inline'). This object controls whether scripting is enabled for the given type, together with other fine grained control parameters.
inline (ElasticsearchScriptTypeSettings)
Scripts can be stored in indexes ('stored'), or uploaded in file bundles ('file'), or used directly in API requests ('inline'). This object controls whether scripting is enabled for the given type, together with other fine grained control parameters.
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)
Scripts can be stored in indexes ('stored'), or uploaded in file bundles ('file'), or used directly in API requests ('inline'). This object controls whether scripting is enabled for the given type, together with other fine grained control parameters.

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 of different types (available and unavailable - unavailable is bad and means that a cluster cannot serve all its data) for each instance container hosting an Elasticsearch node

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

This structure defines a curated subset of the Elasticsearch settings that are of particular relevance to ECE. (This field together with 'user_settings_override_' and 'user_settings_' defines the total set of Elasticsearch 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 different 'languages' (painless/mustache/expressions) supported by the Elasticsearch cluster, and the different ways they can be used (file, index, inline). More complex configurations need to be handled by leaving these blank and controlling instead 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 (eg scripts, synonym files) that are available for this user. Not yet supported in ECE, SaaS only

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 that are available for this user. Not yet supported in ECE, SaaS only

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 body of the request for elevated permissions

Properties

token (string, required)
Multi-factor authorization token

Example

{
   "token" : "string"
}

ElevatedPermissions

A user's elevated permissions status

Properties

enabled (boolean, required)
True if the user has elevated permissions
expires_at (string as date-time)
The time at which the user's elevated permissions expire

Example

{
   "enabled" : true,
   "expires_at" : "2019-01-01T00:00:00Z"
}

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 simple strategy that creates new instances with the new plan, migrates data across from the old instances, and then shuts down the old instances - it 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

Description of which allocator instances are assigned to and also allows settings to be added to instance data.

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

Requests that the specified instances be moved to (optionally specified) different 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

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

Container for multiple rules

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

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 settings to configure 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 info object for a Kibana cluster

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 associated 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)
The cluster metadata stores a combination of public and internal state and configuration for a cluster. The unstructured content is undocumented unless explicitly stated elsewhere in the docs
plan_info (KibanaClusterPlansInfo, required)
Information about the current, pending, and past plans of a cluster
region (string)
The region that this cluster belongs to. Only populated in SaaS or federated ECE.
status (string; allowed values: [initializing, stopping, stopped, rebooting, restarting, reconfiguring, started])
Cluster status
topology (ClusterTopologyInfo, required)
A description of the cluster topology (the different instances/containers making up the cluster, 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",
   "status" : "string",
   "topology" : {
      "healthy" : true,
      "instances" : [
         {
            "allocator_id" : "string",
            "container_started" : true,
            "disk" : {
               "disk_space_available" : 0,
               "disk_space_used" : 0
            },
            "healthy" : true,
            "instance_configuration" : {
               "id" : "string",
               "name" : "string",
               "resource" : "string"
            },
            "instance_name" : "string",
            "maintenance_mode" : true,
            "memory" : {
               "instance_capacity" : 0,
               "memory_pressure" : 0,
               "native_memory_pressure" : 0
            },
            "service_id" : "string",
            "service_roles" : [
               "string"
            ],
            "service_running" : true,
            "service_version" : "string",
            "zone" : "string"
         }
      ]
   }
}

KibanaClusterPlan

Intentionally left blank

Properties

cluster_topology (array[KibanaClusterTopologyElement])
kibana (KibanaConfiguration, required)
transient (TransientKibanaPlanConfiguration)
Defines configuration parameters that control how the plan (ie consisting of the cluster topology and Kibana settings) is applied
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 a current, pending, or past 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)
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, and past plans of a cluster

Properties

current (KibanaClusterPlanInfo)
Information about a current, pending, or past 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 a current, pending, or past 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
}

KibanaClusterTopologyElement

Defines the topology of the Kibana nodes (eg number/capacity 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)
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)
The size of a topology measured by the amount of some resource. The final cluster size is calculated using multipliers from the topology's 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

A container for information about on a set of the Kibana clusters

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",
         "status" : "string",
         "topology" : {
            "healthy" : true,
            "instances" : [
               {
                  "allocator_id" : "string",
                  "container_started" : true,
                  "disk" : {
                     "disk_space_available" : 0,
                     "disk_space_used" : 0
                  },
                  "healthy" : true,
                  "instance_configuration" : {
                     "id" : "string",
                     "name" : "string",
                     "resource" : "string"
                  },
                  "instance_name" : "string",
                  "maintenance_mode" : true,
                  "memory" : {
                     "instance_capacity" : 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

Intentionally left blank

Properties

docker_image (string)
A docker URI that allows overriding of the default docker image specified for this version
system_settings (KibanaSystemSettings)
This structure defines a curated subset of the Kibana settings that are of particular relevance to ECE. (This field together with 'user_settings_override_' and 'user_settings_' defines the total set of Elasticsearch 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

Intentionally left blank

Properties

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

Example

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

KibanaSubClusterInfo

Information about any Kibana clusters associated with this 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

This structure defines a curated subset of the Kibana settings that are of particular relevance to ECE. (This field together with 'user_settings_override_' and 'user_settings_' defines the total set of Elasticsearch 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"
}

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

Container for a license

Properties

license (LicenseInfo, required)
License data

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

ListEnrollmentTokenElement

Information about a currently 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 currently 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)
Configures 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

Configures 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

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

The most simple query, which matches all documents.

Example

{}

MatchQuery

Match queries accept text/numerics/dates, analyzes them, and 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

Represents an arbitrary metadata item as a key/value pair

Properties

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

Example

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

MetadataItemValue

Represents only the value of a metadata item, primarily used for adding a single item where the key is provided in the URL.

Properties

value (string, required)
The metadata value

Example

{
   "value" : "string"
}

MetadataItems

A 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

Configuration object for moving Apm clusters.

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

Detailed information about the Apm cluster being moved.

Properties

calculated_plan (TransientApmPlanConfiguration)
If only validating the move, then the plan configuration that would be applied to the cluster.
cluster_id (string)
Identifier for the Apm cluster.
errors (array[BasicFailedReply])
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" : [
      {
         "errors" : [
            {
               "code" : "string",
               "fields" : [
                  "string"
               ],
               "message" : "string"
            }
         ]
      }
   ]
}

MoveClustersCommandResponse

Detailed information about the cluster move operations being performed.

Properties

failures (MoveClustersDetails)
Detailed information about the clusters that failed to move.
moves (MoveClustersDetails)
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" : [
               {
                  "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_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

Detailed information about the clusters that are being moved off 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" : [
            {
               "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_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

Configuration for moving 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_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

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

Detailed information about the Elasticsearch cluster being moved.

Properties

calculated_plan (TransientElasticsearchPlanConfiguration)
If only validating the move, then the plan configuration that would be applied to the cluster.
cluster_id (string)
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_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

Configuration object for moving Kibana clusters.

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

Detailed information about the Kibana cluster being moved.

Properties

calculated_plan (TransientKibanaPlanConfiguration)
If only validating the move, then the plan configuration that would be applied to the cluster.
cluster_id (string)
Identifier for the Kibana cluster.
errors (array[BasicFailedReply])
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" : [
      {
         "errors" : [
            {
               "code" : "string",
               "fields" : [
                  "string"
               ],
               "message" : "string"
            }
         ]
      }
   ]
}

NestedQuery

A query that is applicable to 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" : {},
      "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

Node type information

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
version (integer as int32)
Note version

Example

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

Notes

User notes

Properties

notes (array[Note])
Notes
version (integer as int32)
Notes version

Example

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

PlanStrategy

Describes various options that affect how we will perform a plan change. Only one of these can be specified at a time. The default is to let the system decide on the best method (currently it will always be 'grow_and_shrink' unless manually specified)

Properties

grow_and_shrink (GrowShrinkStrategyConfig)
A simple strategy that creates new instances with the new plan, migrates data across from the old instances, and then shuts down the old instances - it is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters
rolling (RollingStrategyConfig)
Allows for performing many configuration changes in-line in a rolling manner, mutating existing containers.It is the fastest way of updating a plan, but may fail for more complex plan changes (eg topology changes) and is less safe for eg configuration changes that can leave a cluster in a non-running state. Note that rolling (with 'group_by' set to '__all__') is required when performing a major version upgrade
rolling_grow_and_shrink (RollingGrowShrinkStrategyConfig)
A simple strategy that creates new instances with the new plan one by one, migrates data from one node that needs to be removed and proceeds to the next node to add/remove. It allows minimizing the amount of spare capacity needed.

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

Details about a 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

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

Matches documents that have fields containing terms with a specified prefix (not analyzed).

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

ProxiesHttpSettings

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

Settings for all of the 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
}

ProxyInfo

Information about a proxy

Properties

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

Example

{
   "healthy" : true,
   "host_ip" : "string",
   "metadata" : {},
   "proxy_id" : "string",
   "public_hostname" : "string",
   "runner_id" : "string"
}

ProxyOverview

Information about all proxies

Properties

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

Example

{
   "proxies" : [
      {
         "healthy" : true,
         "host_ip" : "string",
         "metadata" : {},
         "proxy_id" : "string",
         "public_hostname" : "string",
         "runner_id" : "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

Container for all of the allowed Elasticsearch queries. Only one can be specified.

Properties

bool (BoolQuery)
A query that matches documents matching 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)
The most simple query, which matches all documents.
nested (NestedQuery)
A query that is applicable to nested objects.
prefix (map[string,PrefixQuery])
query_string (QueryStringQuery)
A query that uses the SimpleQueryParser to parse its context.
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" : {},
   "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 to parse its context.

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

Matches documents with fields that have terms within a certain 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"
}

RemoteClusterRef

A reference to Elasticsearch cluster to connect 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

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 an enrollment token that can be used to start a new server with designated roles securely

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

Provides fine grained control over the restore command (in particular which indices 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

Allows for a snapshot of existing data to be applied from a local or remote repository once the new/upgraded cluster is up

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)
Provides fine grained control over the restore command (in particular which indices 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 (defaults to the Elastic Cloud system repo)

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 simple strategy that creates new instances with the new plan one by one, migrates data from one node that needs to be removed and proceeds to the next node to add/remove. It allows minimizing the amount of spare capacity needed.

Example

{}

RollingStrategyConfig

Allows for performing many configuration changes in-line in a rolling manner, mutating existing containers.It is the fastest way of updating a plan, but may fail for more complex plan changes (eg topology changes) and is less safe for eg configuration changes that can leave a cluster in a non-running state. Note that rolling (with 'group_by' set to '__all__') is required when performing a major version upgrade

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

Response value after successfully creating 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
}

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 given runner

Properties

connected (boolean, required)
Specifies if the runner is connected
containers (array[RunnerContainerInfo], required)
Containers for 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

Example

{
   "connected" : true,
   "containers" : [
      {
         "container_name" : "string",
         "container_set_name" : "string"
      }
   ],
   "healthy" : true,
   "host_ip" : "string",
   "public_hostname" : "string",
   "roles" : [
      {
         "role_name" : "string"
      }
   ],
   "runner_id" : "string"
}

RunnerOverview

Overview over all runners

Properties

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

Example

{
   "runners" : [
      {
         "connected" : true,
         "containers" : [
            {
               "container_name" : "string",
               "container_set_name" : "string"
            }
         ],
         "healthy" : true,
         "host_ip" : "string",
         "public_hostname" : "string",
         "roles" : [
            {
               "role_name" : "string"
            }
         ],
         "runner_id" : "string"
      }
   ]
}

RunnerRoleInfo

Information about a role for a runner

Properties

role_name (string, required)
Name of the role

Example

{
   "role_name" : "string"
}

RunnerRolesInfo

The list of roles for a runner

Properties

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

Example

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

SearchRequest

Represents an Elasticsearch search request, but with a limited subset of options.

Properties

from (integer as int32)
query (QueryContainer)
Container for all of the allowed Elasticsearch queries. Only one can be specified.
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" : {},
      "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"
   ]
}

SnapshotRepositoryConfiguration

Represents an Elasticsearch snapshot repository configuration block.

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 this cluster's snapshot status (health, etc.)

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

APM related configuration of an Elastic Stack version

Properties

blacklist (array[string], required)
List of configuration options that cannot be overridden by user settings
capacity_constraints (StackVersionInstanceCapacityConstraint)
Instance capacity constraints for the 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

Provides information about errors that occurred while 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

Result of processing the submitted archive

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

Details for a 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)
APM related configuration of an Elastic Stack version
deleted (boolean)
Identifies that the Elastic Stack version is marked for deletion
elasticsearch (StackVersionElasticsearchConfig)
Elasticsearch related configuration of an Elastic Stack version
kibana (StackVersionKibanaConfig)
Kibana related configuration of an Elastic Stack version
metadata (StackVersionMetadata)
Stack Pack's metadata
template (StackVersionTemplateInfo)
Template details for a stack
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

Elastic Stack version configuration

Properties

apm (StackVersionApmConfig)
APM related configuration of an Elastic Stack version
elasticsearch (StackVersionElasticsearchConfig)
Elasticsearch related configuration of an Elastic Stack version
kibana (StackVersionKibanaConfig)
Kibana related configuration of an Elastic Stack version
metadata (StackVersionMetadata)
Stack Pack's metadata

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

Collection of Elastic Stack versions

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

Elasticsearch related configuration of an Elastic Stack version

Properties

blacklist (array[string], required)
List of configuration options that cannot be overridden by user settings
capacity_constraints (StackVersionInstanceCapacityConstraint)
Instance capacity constraints for the 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

Instance capacity constraints for the 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

Kibana related configuration of an Elastic Stack version

Properties

blacklist (array[string], required)
List of configuration options that cannot be overridden by user settings
capacity_constraints (StackVersionInstanceCapacityConstraint)
Instance capacity constraints for the 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

Stack Pack's metadata

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

Configuration for an Elastic Stack node type

Properties

capacity_constraints (StackVersionInstanceCapacityConstraint)
Instance capacity constraints for the 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

Template file hash

Properties

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

Example

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

StackVersionTemplateInfo

Template details for a stack

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 associated 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

Finds documents that contain the exact term specified in the inverted index.

Properties

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

Example

{
   "value" : {}
}

TiebreakerTopologyElement

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

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. 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 to login (without redirect configured) or enable\disable elevated permissions

Properties

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

Example

{
   "token" : "string"
}

TopologySize

The size of a topology measured by the amount of some resource. The final cluster size is calculated using multipliers from the topology's 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 configuration parameters that control how the plan (ie consisting of the cluster topology and Apm settings) is applied

Properties

plan_configuration (ApmPlanControlConfiguration)
strategy (PlanStrategy)
Describes various options that affect how we will perform a plan change. Only one of these can be specified at a time. The default is to let the system decide on the best method (currently it will always be 'grow_and_shrink' unless manually specified)

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 configuration parameters that control how the plan (ie consisting of the cluster topology and Elasticsearch settings) is applied

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)
Fine grained control over various timeout and fallback parameters
restore_snapshot (RestoreSnapshotConfiguration)
Allows for a snapshot of existing data to be applied from a local or remote repository once the new/upgraded cluster is up
strategy (PlanStrategy)
Describes various options that affect how we will perform a plan change. Only one of these can be specified at a time. The default is to let the system decide on the best method (currently it will always be 'grow_and_shrink' unless manually specified)

Example

{
   "cluster_settings_json" : {},
   "plan_configuration" : {
      "calm_wait_time" : 0,
      "cluster_reboot" : "string",
      "extended_maintenance" : true,
      "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 configuration parameters that control how the plan (ie consisting of the cluster topology and Kibana settings) is applied

Properties

plan_configuration (KibanaPlanControlConfiguration)
strategy (PlanStrategy)
Describes various options that affect how we will perform a plan change. Only one of these can be specified at a time. The default is to let the system decide on the best method (currently it will always be 'grow_and_shrink' unless manually specified)

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

User

An API user

Properties

security (UserSecurity, required)
The user's security information
user_id (string, required)
The user's identifier

Example

{
   "security" : {
      "elevated_permissions" : {
         "enabled" : true,
         "expires_at" : "2019-01-01T00:00:00Z"
      },
      "permissions" : [
         "string"
      ],
      "roles" : [
         "string"
      ]
   },
   "user_id" : "string"
}

UserSecurity

A user's security information

Properties

elevated_permissions (ElevatedPermissions, required)
The user's elevated permission status
permissions (array[string], required)
The distinct set of permissions allowed by the user's roles. These correspond to operationId values in the OpenAPI definition.
roles (array[string], required)
The set of roles assigned to a user

Example

{
   "elevated_permissions" : {
      "enabled" : true,
      "expires_at" : "2019-01-01T00:00:00Z"
   },
   "permissions" : [
      "string"
   ],
   "roles" : [
      "string"
   ]
}