Start Typesense reindex

POST

reindex

curl -X POST "http://YOUR_BLNK_INSTANCE_URL/search/reindex" \
  -H "X-Blnk-Key: YOUR_API_KEY"

{
    "status": "in_progress",
    "phase": "indexing_transactions",
    "total_records": 2145709,
    "processed_records": 2145709,
    "started_at": "2026-02-12T12:13:10.448612096Z"
}

{
  "error": "A reindex operation is already in progress",
  "error_detail": {
    "code": "SRCH_REINDEX_IN_PROGRESS",
    "message": "A reindex operation is already in progress",
    "details": {
      "status": "in_progress",
      "phase": "create_collections",
      "total_records": 0,
      "processed_records": 0,
      "started_at": "2026-06-13T00:36:38.149512Z"
    }
  }
}

Start a reindex to populate Typesense with data from your existing database. Use when you spin up a new Typesense instance alongside a database that already contains records.

If you’re using the auto-provisioned Enterprise Core instance included with your Production License deployment, set the base URL to: https://ENTERPRISE_PUBLIC_URL/core.If you’re connecting to a different Core instance, use the publicly accessible base URL for that instance instead.

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>. Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code. See also: Scoped API keys and Secure your Blnk server.

Response

string

Current state: in_progress or completed.

string

Current phase (e.g. indexing_transactions) or done when complete.

integer

Total number of records to index.

integer

Number of records processed so far.

string

ISO 8601 timestamp when reindex began.

string

ISO 8601 timestamp when reindex finished. Only present when status is completed.

array

Array of error messages. Only present when an error occurs during reindex.

curl -X POST "http://YOUR_BLNK_INSTANCE_URL/search/reindex" \
  -H "X-Blnk-Key: YOUR_API_KEY"

{
    "status": "in_progress",
    "phase": "indexing_transactions",
    "total_records": 2145709,
    "processed_records": 2145709,
    "started_at": "2026-02-12T12:13:10.448612096Z"
}

{
  "error": "A reindex operation is already in progress",
  "error_detail": {
    "code": "SRCH_REINDEX_IN_PROGRESS",
    "message": "A reindex operation is already in progress",
    "details": {
      "status": "in_progress",
      "phase": "create_collections",
      "total_records": 0,
      "processed_records": 0,
      "started_at": "2026-06-13T00:36:38.149512Z"
    }
  }
}

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.

Search via Typesense

Check reindex progress

curl -X POST "http://YOUR_BLNK_INSTANCE_URL/search/reindex" \
  -H "X-Blnk-Key: YOUR_API_KEY"

{
    "status": "in_progress",
    "phase": "indexing_transactions",
    "total_records": 2145709,
    "processed_records": 2145709,
    "started_at": "2026-02-12T12:13:10.448612096Z"
}

{
  "error": "A reindex operation is already in progress",
  "error_detail": {
    "code": "SRCH_REINDEX_IN_PROGRESS",
    "message": "A reindex operation is already in progress",
    "details": {
      "status": "in_progress",
      "phase": "create_collections",
      "total_records": 0,
      "processed_records": 0,
      "started_at": "2026-06-13T00:36:38.149512Z"
    }
  }
}

Start Here

Ledgers

Ledger balances

Transactions

Reconciliation

Identities

Metadata

Search

Transaction hooks

API keys

System

Authorization

Response

Need help?

​Authorization

​Response

​Need help?

Authorization

Response

Need help?