It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Status URL for monitoring?

Is there an API call or other URL I can visit to get a status from JIRA and Confluence? I'm working on setting up monitoing with Nagios / Icinga. I can do a generic "hit the main page and check for 200", type of thing, I'd rather get an authoritative value back from the service itself.

3 answers

2 accepted

8 votes
Answer accepted

In JIRA, you can hit the URL /status and it will return 

{
   state: "RUNNING"
}

and eventually in 7.1, it will also return "MAINTENANCE" if you are doing something like performing a foreground index. https://jira.atlassian.com/browse/JRA-46458

This is a nice way too since it does not require authentication and also does not create a session on the JIRA server unnecessarily. 

Confluence also has a /status page that returns the same result.

Is there documentation on all possible responses from this endpoint?

So far we've observed:

  • STARTING
  • ERROR
  • RUNNING
  • MAINTENANCE

Mainly we're curious what to do when it's ERROR (generally this is on startup and seems to not necessarily recur on a restart).

For JIRA, doesn't appear there is much besides https://confluence.atlassian.com/enterprise/jira-data-center-load-balancer-examples-781200827.html.  

For Confluence, someone submitted https://jira.atlassian.com/browse/CONF-41395 which ended up getting the Load Balancing section of https://confluence.atlassian.com/enterprise/confluence-data-center-technical-overview-612959401.html updated.  I would assume the JIRA statuses are similar, if not identical.

I submitted a similar story just now (https://jira.atlassian.com/browse/JRA-63928) to possible bolster the documentation for JIRA's statuses.  But here are the ones from Confluence, and I am guessing they are similar.

 

HTTP Status Code

Response entity

Description

200

{"state":"RUNNING"}

Running normally

500 

{"state":"ERROR"}

An error state

503

{"state":"STARTING"}

Application is starting

503

{"state":"STOPPING"}

Application is stopping

200

{"state":"FIRST_RUN"}

Application is running for the first time and has not yet been configured

404

 

Application failed to start up in an unexpected way (the web application failed to deploy)

5 votes
Answer accepted

There isn't a formal status API that I'm aware of, but the AppLinks Manifest end-point is a good URL you can hit for most of our products (JIRA, Confluence, Stash, Bamboo, FishEye and Crucible). If it returns a 200, your server is probably in good shape.

It does not require authentication and is available at:

/rest/applinks/latest/manifest

in all products.

e.g.

https://jira.atlassian.com/rest/applinks/latest/manifest

https://confluence.atlassian.com/rest/applinks/latest/manifest

cheers,

Tim

Thanks, I think this will work.

Tim Pettersen [Atlassian]

i tried above manifest, it is showing lot of other info, but not status.

how to get status of Bamboo and Crowd, like we get for JIRA and confluence - <url>/status ? if it is not there, can  you please add a enhancement request or let us know any workaround for this.

we need this, we use to show status of all our Atlassian apps.

Thanks for your help.

0 votes
Davin Studer Community Leader Feb 20, 2014

Not really, but getting a 200 response from the site main page should be pretty authoritative, no?

A 200 from a page that makes a DB call and/or runs a basic health check would suffice...but any successfully loading page? I wouldn't call that a proper status check.

Suggest an answer

Log in or Sign up to answer
Community showcase
Posted in Jira

Calling all Jira Cloud users! Give us feedback on our exploration of a new navigation.

Hi everyone! My name’s Matt and I’m a product manager at Atlassian. I work in the navigation & findability space for all our Jira Cloud products. We’ve been working on trying to improve the exp...

811 views 13 12
Join discussion

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you