Responses

• 200 application/json

  The platform information is retrieved.

  Hide response attributes Show response attributes object

  • version string Required

    Platform version

  • services array[object] Required

    The platform service information.

    Hide services attributes Show services attributes object

    • type string Required

      Name of service

    • image array[object] Required

      The docker image that is used to run a service.

      Hide image attributes Show image attributes object

      • id string Required

        Id of runner that hosts the container

      • tag string Required

        Image tag

      • version string Required

        Version of service

      • hash string Required

        Image hash code

  • phone_home_enabled boolean Required

    Is the phone-home service, which returns anonymized usage statistics to Elastic, enabled

  • eula_accepted boolean Required

    Indicates if the End User License Agreement been accepted

  • regions array[object] Required

    Information on regions

    Information about a region.

    Hide regions attributes Show regions attributes object

    • region_id string Required

      Identifier of this region

    • zookeeper_states object Required

      Information about the ZooKeeper state.

      Hide zookeeper_states attribute Show zookeeper_states attribute object

      • states array[object] Required

        Information about the nodes

        Information about a ZooKeeper node.

        Hide states attributes Show states attributes object

        • id string Required

          Identifier of this ZooKeeper node

        • state string Required

          State of the ZooKeeper node

          Values are connected, suspended, reconnected, lost, or read_only.

    • allocators object Required

      Summarized information about allocators.

      Hide allocators attributes Show allocators attributes object

      • healthy boolean Required

        Whether all allocators are healthy

      • zone_summaries array[object] Required

        Summarized information on allocators in each zone

        Summary of the allocators for the specified zone.

        Hide zone_summaries attributes Show zone_summaries attributes object

        • zone_id string Required

          Identifier of the zone

        • total_allocators integer(int32) Required

          Total number of allocators

        • healthy_allocators integer(int32) Required

          Number of healthy allocators

        • connected_allocators integer(int32) Required

          Number of connected allocators

        • disconnected_allocators integer(int32) Required

          Number of disconnected allocators

        • in_maintenance_allocators integer(int32) Required

          Number of connected allocators in maintenance

        • connected_capacity integer(int32) Required

          Capacity of connected allocators in megabytes

        • max_available_capacity integer(int32) Required

          Maximum capacity available in one allocator in megabytes

        • instances integer(int32) Required

          Number of instances across all allocators in the region

    • runners object Required

      Summarized information about the runners.

      Hide runners attributes Show runners attributes object

      • healthy boolean Required

        Whether all runners are healthy

      • total_runners integer(int32) Required

        Total number of runners

      • healthy_runners integer(int32) Required

        Number of healthy runners

      • connected_runners integer(int32) Required

        Number of connected runners

      • connected_capacity integer(int32) Required

        Total capacity of connected runners in megabytes

      • max_available_capacity integer(int32) Required

        Maximum capacity available in one runner in megabytes

      • containers_count integer(int32) Required

        Total number of containers

    • proxies object Required

      Summarized information about proxies.

      Hide proxies attributes Show proxies attributes object

      • healthy boolean Required

        Whether all proxies are healthy

      • expected_proxies_count integer(int32) Required

        Expected number of proxies

      • proxies_count integer(int32) Required

        Total number of proxies

      • proxies array[object] Required

        Summarized information about each proxy

        Summarized information about a proxy.

        Hide proxies attributes Show proxies attributes object

        • proxy_id string Required

          The proxy identifier

        • healthy boolean Required

          Whether this proxy is healthy

    • container_sets_status object Required

      Summarized information about container sets

      Hide container_sets_status attributes Show container_sets_status attributes object

      • healthy boolean Required

        Whether all container sets are healthy

      • healthy_container_sets_count integer(int32) Required

        Number of healthy container sets

      • unhealthy_container_sets_count integer(int32) Required

        Number of unhealthy container sets

      • unhealthy_container_sets array[object] Required

        Summarized information about unhealthy container sets

        Summarized information about a container set

        Hide unhealthy_container_sets attributes Show unhealthy_container_sets attributes object

        • container_set_id string Required

          The identifier for this container set

        • healthy boolean Required

          Whether the container set is healthy

        • hidden boolean Required

          True if the container set is hidden

        • containers_created_count integer(int32) Required

          Number of containers created in this container set

        • containers_started_count integer(int32) Required

          Number of containers started in this container set

        • containers_running_count integer(int32) Required

          Number of containers running in this container set

        • containers_expected_running_count integer(int32) Required

          Expected number of running containers in this container set

    • constructors object Required

      The overview information for the installed constructors.

      Hide constructors attribute Show constructors attribute object

      • constructors array[object] Required

        Information about the constructor.

        Hide constructors attributes Show constructors attributes object

        • status object Required

          The health status of the constructor.

          Hide status attributes Show status attributes object

          • connected boolean Required

            Whether the constructor is connected

          • maintenance_mode boolean Required

            Whether the constructor is in maintenance mode

        • constructor_id string Required

          Identifier for this constructor

    • coordinators object Required

      Summarized information about coordinators.

      Hide coordinators attribute Show coordinators attribute object

      • coordinators array[object] Required

        Summarized information on each coordinator

        Summarized information about a coordinator.

        Hide coordinators attributes Show coordinators attributes object

        • name string Required

          Name of this coordinator

        • public_hostname string Required

          Public hostname of this coordinator

        • leader_port integer(int32) Required

          Leader port of this coordinator

        • election_port integer(int32) Required

          Election port of this coordinator

        • client_port integer(int32) Required

          Client port of this coordinator

        • attributes object Required

          Attributes of this coordinator

          Hide attributes attribute Show attributes attribute object

          • * string Additional properties
    • resources object Required

      Information about resources.

      Hide resources attributes Show resources attributes object

      • healthy boolean Required

        Whether all resources are healthy

      • available_count integer(int32) Required

        Number of available resources

      • used_count integer(int32) Required

        Number of used resources

      • missing_count integer(int32) Required

        Number of missing resources

      • minimum_available_count integer(int32) Required

        Minimum number of available resources

      • account_count integer(int32) Required

        Number of accounts

  • unreachable_regions array[object] Required

    Information on currently unreachable regions

    Information about an unreachable region.

    Hide unreachable_regions attribute Show unreachable_regions attribute object

    • region_id string Required

      Identifier of this region