Get platform info

GET /platform

Retrieves information about the active platform.

Responses

  • 200

    The platform information is retrieved.

    Hide response attributes Show response attributes object
    • version string Required

      Platform version

    • services array[object] Required
      Hide services attributes Show services attributes object
      • type string Required

        Name of service

      • image array[object] Required
        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

      Hide regions attributes Show regions attributes object
      • region_id string Required

        Identifier of this region

      • zookeeper_states object Required

        Information about the Zookeeper state

        Additional properties are allowed.

        Hide zookeeper_states attribute Show zookeeper_states attribute object
        • states array[object] Required

          Information about the nodes

          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

        Information about allocators

        Additional properties are allowed.

        Hide allocators attributes Show allocators attributes object
      • runners object Required

        Information about runners

        Additional properties are allowed.

        Hide runners attributes Show runners attributes object
      • proxies object Required

        Information about proxies

        Additional properties are allowed.

        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

          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

        Information about container sets

        Additional properties are allowed.

        Hide container_sets_status attributes Show container_sets_status attributes object
      • constructors object Required

        Information about constructors

        Additional properties are allowed.

        Hide constructors attribute Show constructors attribute object
        • constructors array[object] Required
          Hide constructors attributes Show constructors attributes object
          • status object Required

            The health status of the constructor.

            Additional properties are allowed.

            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

        Information about coordinators

        Additional properties are allowed.

        Hide coordinators attribute Show coordinators attribute object
        • coordinators array[object] Required

          Summarized information on each 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

        Additional properties are allowed.

        Hide resources attributes Show resources attributes object
    • unreachable_regions array[object] Required

      Information on currently unreachable regions

      Hide unreachable_regions attribute Show unreachable_regions attribute object
GET /platform 
curl \
 -X GET https://{{hostname}}/api/v1/platform
Response examples (200) 
{
  "version": "string",
  "services": [
    {
      "type": "string",
      "image": [
        {
          "id": "docker.elastic.co/elastic-cloud-enterprise:1.0.0-GA",
          "tag": "docker.elastic.co/elastic-cloud-enterprise:1.0.0-GA",
          "version": "1.0.0-GA",
          "hash": "sha256:04a5be1ab07de64269ffa52da26044e0ecc36fa1164e7914468e69d65a2090d4"
        }
      ]
    }
  ],
  "phone_home_enabled": true,
  "eula_accepted": true,
  "regions": [
    {
      "region_id": "string",
      "zookeeper_states": {
        "states": [
          {
            "id": "string",
            "state": "connected"
          }
        ]
      },
      "allocators": {
        "healthy": true,
        "zone_summaries": [
          {
            "zone_id": "string",
            "total_allocators": 42,
            "healthy_allocators": 42,
            "connected_allocators": 42,
            "disconnected_allocators": 42,
            "in_maintenance_allocators": 42,
            "connected_capacity": 42,
            "max_available_capacity": 42,
            "instances": 42
          }
        ]
      },
      "runners": {
        "healthy": true,
        "total_runners": 42,
        "healthy_runners": 42,
        "connected_runners": 42,
        "connected_capacity": 42,
        "max_available_capacity": 42,
        "containers_count": 42
      },
      "proxies": {
        "healthy": true,
        "expected_proxies_count": 42,
        "proxies_count": 42,
        "proxies": [
          {
            "proxy_id": "string",
            "healthy": true
          }
        ]
      },
      "container_sets_status": {
        "healthy": true,
        "healthy_container_sets_count": 42,
        "unhealthy_container_sets_count": 42,
        "unhealthy_container_sets": [
          {
            "container_set_id": "string",
            "healthy": true,
            "hidden": true,
            "containers_created_count": 42,
            "containers_started_count": 42,
            "containers_running_count": 42,
            "containers_expected_running_count": 42
          }
        ]
      },
      "constructors": {
        "constructors": [
          {
            "status": {
              "connected": true,
              "maintenance_mode": true
            },
            "constructor_id": "string"
          }
        ]
      },
      "coordinators": {
        "coordinators": [
          {
            "name": "string",
            "public_hostname": "string",
            "leader_port": 42,
            "election_port": 42,
            "client_port": 42,
            "attributes": {
              "additionalProperty1": "string",
              "additionalProperty2": "string"
            }
          }
        ]
      },
      "resources": {
        "healthy": true,
        "available_count": 42,
        "used_count": 42,
        "missing_count": 42,
        "minimum_available_count": 42,
        "account_count": 42
      }
    }
  ],
  "unreachable_regions": [
    {
      "region_id": "string"
    }
  ]
}