Version API

The /version API endpoint

/version (GET)

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

EXAMPLE

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

curl -X GET \
http://127.0.0.1:8080/version

HTTP/1.1 200 OK
{
  "etcd": {
    "etcdserver": "3.3.17",
    "etcdcluster": "3.3.0"
  },
  "sensu_backend": "5.x.x#yyyyyyy"
}

API Specification

/version (GET)
description Returns the Sensu backend and etcd version for the Sensu instance.
example url http://hostname:8080/version
response type Map
response codes
  • Success: 200 (OK)
  • Error: 500 (Internal Server Error)
response parameters Required:
  • etcd.etcdserver (string). Etcd server version.
  • sensu_backend (string). Sensu backend version in the format x.x.x#yyyyyyy where x.x.x is the Sensu version and yyyyyyy is the release SHA

Optional:
  • etcd.etcdcluster (string). 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.
output 
{
  "etcd": {
    "etcdserver": "3.3.17",
    "etcdcluster": "3.3.0"
  },
  "sensu_backend": "5.x.x#yyyyyyy"
}