Untitled :: Jolokia

Getting the agent version (version)

The Jolokia command version returns the version of the Jolokia agent along with the protocol version.

GET version request

The GET URL for a version request has the following format:

<base-url>/version

For GET request the version part can be omitted since this is the default command if no command is provided as path info.

POST version request

A version POST request has only a single key type which has to be set to version.

Version response

The response value for a version request looks like:

{
  "request": {
    "type": "version"
  },
  "value": {
    "agent": "2.1.1",
    "protocol": "7.2",
    "details": {
      "agent_version": "2.1.1",
      "agent_id": "192.168.0.221-21185-5ce94d31-servlet",
      "server_product": "tomcat",
      "server_vendor": "Apache",
      "server_version": "10.1.16",
      "secured": true,
      "url": "http://192.168.0.221:8080/jolokia"
    },
    "id": "192.168.0.221-21185-5ce94d31-servlet",
    "config": {
      "maxDepth": "15",
      "discoveryEnabled": "false",
      "agentId": "192.168.0.221-21185-5ce94d31-servlet",
      "maxCollectionSize": "0",
      "debug": "false",
      "canonicalNaming": "true",
      "historyMaxEntries": "10",
      "serializeException": "false",
      "includeStackTrace": "false",
      "maxObjects": "0",
      "detectorOptions": "{}",
      "debugMaxEntries": "100"
    },
    "info": {
      "proxy": {},
      "jmx": {}
    }
  },
  "status": 200,
  "timestamp": 1702482830
}

NOTE: Since Jolokia 2.1.0 we can use includeRequest parameter to tell Jolokia to exclude request field from the response.

protocol in the response value contains the protocol version used, agent is the version of the Jolokia agent. See Jolokia protocol versions for the various protocol versions and the interoperability. If the agent is able to detect the server, additional meta information about this server is returned (i.e. the product name, the vendor and optionally some extra information added by the server detector).