Version API

The /version API endpoint

/version (GET)

The /version API endpoint provides HTTP GET access to the Sensu backend and etcd versions for your Sensu instance.

EXAMPLE

The following example demonstrates a request to the /version API, resulting in a JSON map containing Sensu version data.

curl http://127.0.0.1:8080/version

HTTP/1.1 200 OK
{
  "Etcd": {
    "etcdserver": "3.3.2",
    "etcdcluster": "3.3.0"
  },
  "SensuBackend": "5.9.0#xxxxxxx"
}

API Specification

/version (GET)
description Returns the Sensu backend and etcd version for your Sensu instance
example url http://hostname:8080/version
response type Map
response codes
  • Success: 200 (OK)
  • Error: 500 (Internal Server Error)
response parameters
  • Etcd.etcdserver (string, required): etcd server version
  • Etcd.etcdcluster (string, optional): etcd cluster version for Sensu instances with the default embedded etcd; not required to match the etcd server version or the cluster versions of other backends in the cluster
  • SensuBackend (string, required): Sensu backend version in the format x.x.x#yyyyyyy where x.x.x is the Sensu version and yyyyyyy is the release SHA
  • output
    {
      "Etcd": {
        "etcdserver": "3.3.2",
        "etcdcluster": "3.3.0"
      },
      "SensuBackend": "5.9.0#xxxxxxx"
    }