Skip to navigation
Product SearchIndexes

Set Alias

Create an alias, or point it at another index in one step. Every request through the alias reaches the new index from then on.

Authentication

AuthorizationBearer

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

Path parameters

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

Headers

Idempotency-KeystringOptional<=255 characters

Replays within 24 hours return the stored response (header Idempotent-Replayed: true). The same key on a different request answers 422. A concurrent duplicate answers 409. Failed requests do not keep the key.

Request

This endpoint expects an object.
indexstringRequired

Response

set
aliasstringOptional
indexstringOptional
previousstring or nullOptional