Skip to main content
GET
/
search
/
reindex
Get reindex status
curl --request GET \
  --url http://localhost:5001/search/reindex \
  --header 'X-blnk-key: <api-key>'
import requests

url = "http://localhost:5001/search/reindex"

headers = {"X-blnk-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-blnk-key': '<api-key>'}};

fetch('http://localhost:5001/search/reindex', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "5001",
CURLOPT_URL => "http://localhost:5001/search/reindex",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-blnk-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "http://localhost:5001/search/reindex"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-blnk-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:5001/search/reindex")
.header("X-blnk-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:5001/search/reindex")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["X-blnk-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
Use blnk.search.get_reindex_status to check search reindex progress.
1

Call the method

blnk.search.get_reindex_status
response = blnk.search.get_reindex_status()
This method takes no arguments.
2

Track reindex progress

Poll until response.data["status"] is completed. Compare processed_records to total_records to estimate remaining work.
3

Response

200 OK
{
  "status": "in_progress",
  "phase": "indexing_transactions",
  "total_records": 2145709,
  "processed_records": 2145709,
  "started_at": "2026-02-12T12:13:10.448612096Z"
}
FieldTypeDescription
statusstrCurrent state, in_progress or completed.
phasestrCurrent phase, for example indexing_transactions, or done when complete.
total_recordsnumberTotal number of records to index.
processed_recordsnumberNumber of records processed so far.
started_atstrTimestamp when the reindex began.
completed_atstrTimestamp when the reindex finished. Only present once status is completed.
errorslist[dict]Array of error messages. Only present when an error occurs.

How reindexing works

When and why to rebuild the index.

Check reindex progress

HTTP request and response schema.

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.