Skip to navigation
Product SearchIndexes

Delete Alias

Remove an alias. The index stays.

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.

Response

deleted
deletedstringOptional
indexstringOptional
keys_narrowedlist of stringsOptional
keys_revokedlist of stringsOptional