How to retrieve Health Check results using REST API

Still need help?

The Atlassian Community is here for you.

Ask the community

Platform notice: Server and Data Center only. This article only applies to Atlassian products on the server and data center platforms.

Purpose

Admins would like the ability to retrieve the health check results using REST API. This article provides details on how to do so.

These REST calls must performed with authentication as a user with either the JIRA System Administrator or JIRA Administrator global permission

Solution

If using the Support Tools  Plugin:

Send GET to:

http://<jira-baseurl>/rest/supportHealthCheck/1.0/check/

If using the Atlassian Troubleshooting & Support Tools Plugin:

Send GET to:

http://<jira-baseurl>/rest/troubleshooting/1.0/check/

Health Check results will return for example: 

{
  "statuses": [
    {
      "id": 0,
      "completeKey": "com.atlassian.jira.plugins.jira-healthcheck-plugin:hsqlHealthCheck",
      "name": "Embedded database",
      "description": "Checks if the instance is connected to an HSQL or H2 database",
      "isHealthy": true,
      "failureReason": "You are not using an HSQL or H2 embedded database with a production license.",
      "application": "JIRA",
      "time": 1484054268590,
      "severity": "undefined",
      "documentation": "https://confluence.atlassian.com/x/1guaEQ",
      "tag": "Supported Platforms",
      "healthy": true
    },
    {
      "id": 0,
      "completeKey": "com.atlassian.jira.plugins.jira-healthcheck-plugin:eolHealthCheck",
      "name": "End of Life",
      "description": "Checks if the running version of JIRA is approaching, or has reached End of Life.",
      "isHealthy": true,
      "failureReason": "JIRA version 7.3.x has not reached End of Life. This version will reach End of Life in 722 days.",
      "application": "JIRA",
      "time": 1484054268591,
      "severity": "undefined",
      "documentation": "https://confluence.atlassian.com/x/HjnRLg",
      "tag": "Supported Platforms",
      "healthy": true
    },
    {
      "id": 0,
      "completeKey": "com.atlassian.jira.plugins.jira-healthcheck-plugin:baseUrlHealthCheck",
      "name": "Base URL",
      "description": "Checks if JIRA is able to access itself through the configured Base URL.",
      "isHealthy": false,
      "failureReason": "JIRA is not able to access itself through the configured Base URL. This is necessary so that dashboard gadgets can be generated successfully. Please verify the current Base URL and if necessary, review your network configurations to resolve the problem.",
      "application": "JIRA",
      "time": 1484054344127,
      "severity": "warning",
      "documentation": "https://confluence.atlassian.com/x/WCA6Mw",
      "tag": "Supported Platforms",
      "healthy": false
    },
....

The above outlines the possibility to retrieve this API CALL through the Web Browser, considering that the user is already logged in. If the user is not logged in, the user will be unable to retrieve the information

If the user would like to get this information through another source, as example, from a Linux terminal, the user can use the basic auth with the curl command, as the example below:

curl --request GET \
  --url '<jira-baseurl>/rest/troubleshooting/1.0/check/' \
  --user 'username:password' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

There another ways to authenticate from API outlined here: Basic auth for REST APIs

DescriptionAdmins would like the ability to retrieve the health check results using REST API. This article provides details on how to do so.
ProductJira
PlatformServer
Last modified on Dec 14, 2022

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.