Retrieve the search indexing details of a repository. This includes the current status, and the commit and timestamp of the last successful index.
If the status is BROKEN then the indexingError will also be included in the response. The indexingError is the error that the application encountered during the last failed indexing attempt before the repository was removed from indexing.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredThe indexing details of the repository.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/indexing/latest/projects/{projectKey}/repos/{repositorySlug}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
{
"indexingError": "Indexing timed out.",
"lastIndexedCommitId": "abcdef0123abcdef4567abcdef8987abcdef6543",
"lastIndexedTimestamp": 1732022086,
"projectKey": "PROJECT_1",
"repositorySlug": "rep_1",
"status": "BROKEN"
}Provides a snapshot of the queue status for a specified repository at the time of the request.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredA snapshot containing the indexing queue information for the repository.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/indexing/latest/projects/{projectKey}/repos/{repositorySlug}/indexing-queue-details' \
--header 'Accept: application/json'1
2
3
4
5
6
{
"capturedAt": 1732136412902,
"nodeId": "58ed5b70-e8ef-4d4e-be13-88221650a51b",
"queued": true,
"queuedAt": 137
}Checks if a repository has been queued for indexing.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredReturns true if the repository has been queued for indexing.
In a clustered environment, this will return true if the repository has been queued for indexing on any node.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/indexing/latest/projects/{projectKey}/repos/{repositorySlug}/indexing-queued-status' \
--header 'Accept: application/json'1
2
3
{
"queued": true
}Forces the provided repositories to reindex with the search server. For each repository the current index on the search server will be deleted and it will be queued for re-indexing. Note that this can result in diminished instance performance as deleting and reindexing a large repository can take some time
Forge and OAuth2 apps cannot access this REST resource.
array<RestRepositorySelector>
string
Requiredstring
RequiredThis status code has no content.
1
2
3
4
5
6
7
8
9
curl --request POST \
--url 'http://{baseurl}/rest/indexing/latest/reindex' \
--header 'Content-Type: application/json' \
--data '[
{
"projectKey": "PRJ",
"slug": "my-repo"
}
]'Restarts the search indexing worker thread. By default this will cause the currently running queue event to be terminated. This behaviour can be modified by providing the graceful shutdown flag in the request.
Forge and OAuth2 apps cannot access this REST resource.
boolean
boolean
any
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/indexing/latest/restart' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"gracefulShutdown": true,
"waitForRestart": true
}'Retrieve repositories which are in the BROKEN indexing state.
When a repository has a BROKEN indexing status it will no longer attempt to be re-indexed by the system, even when changes are made to its code. A repository is given a BROKEN indexing status when it fails to index too many times.
The authenticated user must have SYS_ADMIN permission to call this resource.
Forge and OAuth2 apps cannot access this REST resource.
number
number
Page of repositories where STATE = BROKEN
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/indexing/latest/support-info/broken-index-status-repos' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
{
"isLastPage": true,
"limit": 25,
"nextPageStart": 2154,
"size": 1,
"start": 2154,
"values": [
{
"details": {
"indexingError": "Indexing timed out.",
"lastIndexedCommitId": "abcdef0123abcdef4567abcdef8987abcdef6543",
"lastIndexedTimestamp": 1732022086,
"projectKey": "PROJECT_1",
"repositorySlug": "rep_1",
"status": "BROKEN"
},
"repository": {
"archived": true,
"description": "My repo description",
"forkable": true,
"hierarchyId": "e3c939f9ef4a7fae272e",
"id": 2154,
"name": "My repo",
"origin": {
"archived": true,
"description": "My repo description",
"forkable": true,
"hierarchyId": "e3c939f9ef4a7fae272e",
"id": 2154,
"name": "My repo",
"partition": 2154,
"project": {
"avatar": "<string>",
"description": "The description for my cool project",
"id": 2154,
"key": "PRJ",
"name": "My Cool Project",
"public": true,
"scope": "PROJECT",
"type": "NORMAL"
},
"public": true,
"relatedLinks": {},
"scmId": "git",
"scope": "REPOSITORY",
"slug": "my-repo",
"state": "AVAILABLE",
"statusMessage": "Available"
},
"partition": 2154,
"project": {
"avatar": "<string>",
"description": "The description for my cool project",
"id": 2154,
"key": "PRJ",
"name": "My Cool Project",
"public": true,
"scope": "PROJECT",
"type": "NORMAL"
},
"public": true,
"relatedLinks": {},
"scmId": "git",
"scope": "REPOSITORY",
"slug": "my-repo",
"state": "AVAILABLE",
"statusMessage": "Available"
}
}
]
}Fetches a snapshot of the indexing thread details at the moment the request is processed. Note that the result represents the thread's status at a specific point in time, and the state may have changed by the time this endpoint responds.
Forge and OAuth2 apps cannot access this REST resource.
This request has no parameters.
A snapshot containing the details of the indexing threads.
array<RestIndexingThreadDetails>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/indexing/latest/support-info/indexing-thread-snapshot' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
[
{
"capturedAt": 1732136412902,
"currentProcess": {
"currentTask": "Indexing file: 'example.txt'",
"event": {
"eventMetadata": {},
"eventType": "PROJECT",
"retries": 105
}
},
"delayedQueueSize": 202,
"queueSize": 48,
"state": {
"code": "BROKEN",
"description": "<string>"
}
}
]Rate this page: