GET

Get reindex information

Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned. If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404 indicating that no reindex has taken place.

Request

Query parameters

taskId

integer

Responses

Returns a representation of the progress of the re-index operation.

application/json

ReindexBean
GET/api/2/reindex
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/reindex' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Start a reindex operation

Kicks off a reindex. Need Admin permissions to perform this reindex.

Request

Query parameters

indexChangeHistory

boolean

type

string

indexWorklogs

boolean

indexComments

boolean

Responses

Returns a representation of the progress of the re-index operation.

application/json

ReindexBean
POST/api/2/reindex
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/reindex' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Reindex individual issues

Reindexes one or more individual issues. Indexing is performed synchronously - the call returns when indexing of the issues has completed or a failure occurs.

Request

Query parameters

issueId

array<string>

indexChangeHistory

boolean

indexWorklogs

boolean

indexComments

boolean

Responses

Returns response indicating reindex time.

application/json

ReindexBean
POST/api/2/reindex/issue
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/reindex/issue' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get reindex progress

Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned. If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404 indicating that no reindex has taken place.

Request

Query parameters

taskId

integer

Responses

Returns a representation of the progress of the re-index operation.

application/json

ReindexBean
GET/api/2/reindex/progress
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/reindex/progress' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Execute pending reindex requests

Executes any pending reindex requests. Execution is asynchronous - progress of the returned tasks can be monitored through other REST calls.

Request

This request has no parameters.

Responses

Returns an array containing the reindex request IDs being processed.

application/json

integer

POST/api/2/reindex/request
1 2 3 4 curl --request POST \ --url 'http://{baseurl}/rest/api/2/reindex/request' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get progress of multiple reindex requests

Retrieves the progress of multiple reindex requests. Only reindex requests that actually exist will be returned in the results.

Request

Query parameters

requestId

array<integer>

Responses

An array of results describing the progress of each of the found requests.

application/json

ReindexRequestBean
GET/api/2/reindex/request/bulk
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/reindex/request/bulk' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
GET

Get progress of a single reindex request

Retrieves the progress of a single reindex request.

Request

Path parameters

requestId

integer

Required

Responses

Details and status of the reindex request.

application/json

ReindexRequestBean
GET/api/2/reindex/request/{requestId}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/api/2/reindex/request/{requestId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'

Rate this page: