Get Index
Authentication
A write key, issued by Captain. Server side only. Sent as Authorization: Bearer <key>.
Path parameters
Response headers
the last update seq search had applied when this request started; the answer reflects at least that much (GET …/updates applied_seq). Not on 401 or 403, nor for an index this server does not have
the index’s incarnation, an opaque string: it changes only when the index is deleted and created again (whose seqs start again at 1), or restored from a backup (whose seqs continue from the backup’s). Sent with X-Captain-Applied-Seq
Response
Create Index only: the field that holds each record’s id
empty: no records yet. pending: changes were accepted and are being applied. building: Captain is refreshing suggestions and spelling in the background, and search serves as usual. ready: every change is applied.
the same value as record_count, under its older name
the same value as record_count, under its older name
the same value as pending_changes, under its older name
true for an index with typed fields: every index Create Index makes, and an Algolia import sent with object_search true. Settings apply to these
the build search serves; null before the first one
unix seconds the serving build finished; null when nothing is served, or for a build whose finish time was not recorded