Skip to navigation

Get Synonyms

Get the index's synonyms.

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

X-Captain-Index-VersionstringOptional

the index’s version, an opaque string of at most 64 characters, read when the request started: it changes whenever what a search of this index returns can change (records applied, synonyms or rules live, another build serving, the index re-created). Sent with X-Captain-Applied-Seq

Response

synonyms