How to check if Jira is up and can reply to Jira Align Connector's API calls
Platform Notice: Cloud and Data Center - This article applies equally to both cloud and data center platforms.
Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Summary
How to get sure that Jira, Cloud, or DC/Server are up to respond to Connectors API calls using Health check request.
Solution
There is a Jira API GET method called doHealthCheck that returns JSON content with some information about the Jira instance, indicating it’s up and running and without problems:
1
https://<Jira URL Instace>/rest/api/latest/serverInfo?doHealthCheck=TrueJSON sample in positive cases:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
baseUrl "https://alignsupport.atlassian.net"
version "1001.0.0-SNAPSHOT"
versionNumbers
0 1001
1 0
2 0
deploymentType "Cloud"
buildNumber 100187
buildDate "2022-01-03T05:15:11.000-0600"
serverTime "2022-01-04T08:54:13.451-0600"
scmInfo "319aa7c32b09c4a7a0871e3bf2cbbdff4087cea6"
serverTitle "Jira"
defaultLocale
locale "en_US"This doHealthCheck GET method can be executed by the Jira user’s Browser or any API platform (Postman, SwaggerHub, Akana, etc.). In case of using the browser, just Copy and paste the API call above directly into your Browser navigation bar replacing the <Jira URL Instance> placeholder with Jira URL, it doesn’t need a token or any kind of authentication to run.
For more info on how to do a GET call using an API platform, take a look at https://hello.atlassian.net/wiki/spaces/JALNKB/pages/1441595966
Circumstances where the Jira doHealthCheck can be very useful:
When you suspect Jira is facing communication/Network Problems with the Connector
When you suspect the API gateway might be interfering with the communication between Jira and the Connector
You can test the connection to Jira in order to exclude one of the possibilities as the source of the problem in case the doHealthCheck returns a positive result.
Was this helpful?