Skip to navigation

Get Update Status

Get how far record changes have been applied: the last accepted and the last applied seq.

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

status
incarnationstringOptional

the index’s incarnation, the same value as the X-Captain-Index-Incarnation header: it changes only when the index is deleted and created again, or restored from a backup. Seqs from different incarnations are not comparable

accepted_seqintegerOptional
keyword_seqinteger or nullOptional

the last seq whose added and replaced records match keyword searches (names, brands, SKUs). It is never below applied_seq. null while loading

applied_seqinteger or nullOptional

the last seq that search has fully applied: added and replaced records are fully searchable, with semantic matching and their final ranking. null while loading: nothing is applied yet on this server

pendinginteger or nullOptional
loadingbooleanOptional

present and true while the index is still loading on this server after a restart: it is not served here yet (its searches answer 503 INDEX_LOADING)

last_lag_secondsdouble or nullOptional
last_appliedobject or nullOptional
buildobjectOptional

on servers that build by themselves (Product Search): where the automatic build stands. Small adds are searchable before it runs (keyword_seq, then applied_seq); larger ones when it finishes

pausedenumOptional

present while a backup holds: updates are accepted and applied when it ends

Allowed values:
publish_pausedenumOptional

present while a backup of this index is being taken: a finished build goes live when the backup releases. Absent for an index the backup does not snapshot

Allowed values:
hold_expires_atintegerOptional

with paused or publish_paused: unix seconds when the hold ends at the latest

etaobject or nullOptional

when added records waiting for a build, or being built, will be searchable, estimated from the work ahead of them and this tenant’s recent build speeds; null when nothing waits