How to reindex Jira using REST API via cURL command

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.

This KB describes how to use the REST API to trigger a reindex in Jira. The examples below uses cURL, however you can use the REST client of your choice.


To trigger a Full re-index (Lock Jira and Reindex):

curl --request POST \
  --url '$BASEURL/rest/api/2/reindex?type=FOREGROUND' \
  --user 'username:password'


(info) When type is not specified, the default value will be BACKGROUND_PREFERRED

(info) For all of the following procedures, you must use an account with the Jira Administrators global permission.

Data Center

For Jira Data Center a better approach than background indexing is to take one node out of the cluster and run FOREGROUND reindexing. See  JRASERVER-66969 - Getting issue details... STATUS

When using the Jira Base URL, the request can be routed to any node in your cluster, making that node unavailable until the reindex is finished. To choose a specific node, replace Jira's Base URL with the IP address of that node:

curl --request POST \
  --url '$NODEIP/rest/api/2/reindex?type=FOREGROUND' \
  --user 'username:password'

Notes

Type of re-indexing available:

  • FOREGROUND - runs a lock/full reindexing
  • BACKGROUND - runs a background reindexing. If Jira fails to finish the background reindexing, respond with 409 Conflict (error message).
  • BACKGROUND_PREFERRED  - If possible do a background reindexing. If it's not possible (due to an inconsistent index), do a foreground reindexing.

More information on this REST endpoint can be found in https://docs.atlassian.com/software/jira/docs/api/REST/latest

Last modified on Oct 11, 2021

Was this helpful?

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