Search
Installation search in APIEngine v96 and later runs through SBN-Search, a PostgreSQL-backed search service. APIEngine passes each search to SBN-Search with the caller's user, and SBN-Search limits the results to the dealers that user may see. Setting it up is covered on SBN-Search.
Search routes
| APIEngine version | Route | Backed by |
|---|---|---|
| v96 and later | POST /api/v1/sbnsearch/installation | SBN-Search |
| v96 and later | GET /api/v1/sbnsearch/status | SBN-Search connection status |
| All versions | /api/v1/search/... (for example POST /api/v1/search/sbn/installation) | Elasticsearch |
All routes need a signed-in user token. When Search is turned off on the Settings page, or has no endpoint, /api/v1/sbnsearch/installation returns 503 and runs no search.
Elasticsearch routes
The /api/v1/search/... routes are the earlier installation search, kept for installs that still run an Elasticsearch cluster. The SBN Elasticsearch indexing Windows service that kept that index current has been retired, so new installs use SBN-Search. The Elasticsearch routes read these SBN options:
| Option | Purpose |
|---|---|
es_srch | Turns the Elasticsearch routes on. When off, every route returns "Review APIEngine Logs." |
es_url | Elasticsearch base URL |
es_key1 | Elasticsearch API key |
es_ind1 | Installation index name |
After changing an option, reload options in APIEngine (the diagnostic reloads them).