Get platform info

GET /platform

Auth

Retrieves information about the active platform.

Response

The platform information is retrieved.

application/json

version string required: Platform version
services object[] required
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 object[] required: Information on regions
unreachable_regions object[] required: Information on currently unreachable regions

Examples

Request curl 1 / 1 language

curl Shell

curl -X GET "${API_URL}/platform" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{
  "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": false,
  "eula_accepted": false,
  "regions": [
    {
      "region_id": "string",
      "zookeeper_states": {
        "states": [
          {
            "id": "string",
            "state": "connected"
          }
        ]
      },
      "allocators": {
        "healthy": false,
        "zone_summaries": [
          {
            "zone_id": "string",
            "total_allocators": 0,
            "healthy_allocators": 0,
            "connected_allocators": 0,
            "disconnected_allocators": 0,
            "in_maintenance_allocators": 0,
            "connected_capacity": 0,
            "max_available_capacity": 0,
            "instances": 0
          }
        ]
      },
      "runners": {
        "healthy": false,
        "total_runners": 0,
        "healthy_runners": 0,
        "connected_runners": 0,
        "connected_capacity": 0,
        "max_available_capacity": 0,
        "containers_count": 0
      },
      "proxies": {
        "healthy": false,
        "expected_proxies_count": 0,
        "proxies_count": 0,
        "proxies": [
          {
            "proxy_id": "string",
            "healthy": false
          }
        ]
      },
      "container_sets_status": {
        "healthy": false,
        "healthy_container_sets_count": 0,
        "unhealthy_container_sets_count": 0,
        "unhealthy_container_sets": [
          {
            "container_set_id": "string",
            "healthy": false,
            "hidden": false,
            "containers_created_count": 0,
            "containers_started_count": 0,
            "containers_running_count": 0,
            "containers_expected_running_count": 0
          }
        ]
      },
      "constructors": {
        "constructors": [
          {
            "constructor_id": "string"
          }
        ]
      },
      "coordinators": {
        "coordinators": [
          {
            "name": "string",
            "public_hostname": "string",
            "leader_port": 0,
            "election_port": 0,
            "client_port": 0
          }
        ]
      },
      "resources": {
        "healthy": false,
        "available_count": 0,
        "used_count": 0,
        "missing_count": 0,
        "minimum_available_count": 0,
        "account_count": 0
      }
    }
  ],
  "unreachable_regions": [
    {
      "region_id": "string"
    }
  ]
}

Generated from the API spec