Skip to navigation
App SearchIndexes

Get Index

Get an index's status, how many records it holds, and whether changes are still being applied.

Authentication

AuthorizationBearer

A write key, issued by Captain. Server side only. Sent as Authorization: Bearer <key>.

Path parameters

indexstringRequiredformat: "^[a-z0-9][a-z0-9_-]{0,47}$"
index name

Response headers

X-Captain-Applied-Seqinteger

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

X-Captain-Index-IncarnationstringOptional

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

index
capabilitiesobjectOptional

what an index supports, derived from its settings and served config (field names only: no values, counts or totals). version is bumped on any breaking change; refuse a version you do not know. tenant_field, build and limits come only with an admin key

namestringOptional
aliasstringOptional
id_fieldstringOptional
statusenumOptional

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.

Allowed values:
schema_sourceenumOptional
Allowed values:
record_countintegerOptional
Records the index holds, built or not.
pending_changesbooleanOptional
True while accepted changes are still being applied.
last_build_atinteger or nullOptional

unix seconds the serving build finished; null when nothing is served, or for a build whose finish time was not recorded

build_idstring or nullOptional
last_jobstring or nullOptional
last_errorstring or nullOptional
created_atintegerOptional
nounobjectOptional

what the index holds: settings.noun, else the index name when it reads as a plural noun, else record / records

servingobject or nullOptional
The build search is serving, and how many records it holds.