Path parameters

• allocator_id string Required

  The allocator identifier.

Responses

• 200 application/json

  The information for the allocator specified by {allocator_id}

  Hide response attributes Show response attributes object

  • status object Required

    The health status of the allocator.

    Hide status attributes Show status attributes object

    • connected boolean Required

      Whether the allocator is connected

    • healthy boolean Required

      Whether the allocator is healthy, meaning it is either connected or has no instances

    • health_checks object

      Checks used to determine if an allocator is healthy or not

      Hide health_checks attributes Show health_checks attributes object

      • is_docker_healthy boolean Required

        Check performed by the allocator to figure out if docker is healthy

      • is_connected_to_zk boolean Required

        Whether the allocator is connected to zk or not

      • has_instances boolean Required

        Whether the allocator has allocated instances

    • maintenance_mode boolean Required

      Whether the allocator is in maintenance mode (meaning that new workload won't be assigned to it)

    • maintenance_mode_timestamp string(date-time)

      Timestamp when allocator last entered or exited maintenance mode

  • allocator_id string Required

    Identifier for this allocator

  • zone_id string Required

    Identifier of the zone

  • host_ip string Required

    Host IP of this allocator

  • public_hostname string Required

    Public hostname of this allocator

  • capacity object Required

    The total and used capacity of the allocator.

    Hide capacity attributes Show capacity attributes object

    • memory object Required

      The available and used memory of the allocator.

      Hide memory attributes Show memory attributes object

      • total integer(int32) Required

        Total memory in MB capacity installed on this allocator

      • used integer(int32) Required

        Used memory in MB used by instances assigned to this allocator

    • storage object Required

      The storage capacity of the allocator.

      Hide storage attribute Show storage attribute object

      • total integer(int64) Required

        Total storage in MiB capacity installed on this allocator

    • available_cpus integer(int32)

      Total number of CPUs available on this allocator

    • additional_master_bonus number(float)

      Additional bonus CPU shares available to Elasticsearch master instances

  • settings object Required

    The settings for the allocator.

    Hide settings attribute Show settings attribute object

    • capacity integer(int32)

      A memory capacity (in MB) that overrides the capacity defined during installation - requires separate restart of Allocator services on each host to take full effect.

  • instances array[object] Required

    The status of the allocated Kibana instance or APM Server.

    Hide instances attributes Show instances attributes object

    • cluster_type string Required

      Type of instance that is running

      Values are elasticsearch, kibana, apm, integrations_server, appsearch, or enterprise_search.

    • cluster_id string Required

      Identifier for the cluster this instance belongs

    • cluster_name string

      Name of cluster this instance belongs, if available

    • instance_name string Required

      Instance ID of the instance

    • node_memory integer(int32) Required

      Memory assigned to this instance

    • healthy boolean

      Indicates whether the instance is healthy

    • cluster_healthy boolean

      Indicates whether the cluster the instance belongs to is healthy

    • instance_configuration_id string

      The instance configuration id of this instance

    • moving boolean

      Indicates whether the instance is vacating away from this allocator. Note that this is currently not populated when returned from the search endpoint.

    • plans_info object

      The plans associated with the current instance. Note that this is currently not populated when returned from the search endpoint.

      Hide plans_info attributes Show plans_info attributes object

      • pending boolean Required

        Whether or not there is a pending plan.

      • version string

        The version of the current plan, falling back to that of the pending plan if it exists.

      • zone_count integer(int32)

        The number of zones in the current plan, falling back to that of the pending plan if it exists.

    • deployment_id string

      The id of the deployment this cluster belongs to.

  • metadata array[object] Required

    Arbitrary metadata associated with this allocator

    The key-value pair.

    Hide metadata attributes Show metadata attributes object

    • key string Required

      The metadata field name

    • value string Required

      The metadata value

  • build_info object

    Build Info of the artifact

    Hide build_info attributes Show build_info attributes object

    • commit_hash string

      Git commit hash

    • version string

      Version of the artifact

  • features array[string] Required

    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.

  • external_links array[object] Required

    External resources related to this allocator.

    Hide external_links attributes Show external_links attributes object

    • 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

  • region string

    The region that this allocator belongs to. Only populated in SaaS or federated ECE.

• 404 application/json

  The allocator specified by {allocator_id} cannot be found. (code: allocators.allocator_not_found)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is allocators.allocator_not_found.

  Hide response attribute Show response attribute object

  • errors array[object] Required

    A list of errors that occurred in the failing request

    Hide errors attributes Show errors attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string Required

      A human readable message describing the error 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