v1

latestOpenAPI 3.0.3GPL-3.02026-07-177978150.2 KB
collections

Create or update a collection alias

Create or update a collection alias. An alias is a virtual collection name that points to a real collection. If you're familiar with symbolic links on Linux, it's very similar to that. Aliases are useful when you want to reindex your data in the background on a new collection and switch your application to it without any changes to your code.

put/aliases/{aliasName}

Path parameters

aliasNamestring required

The name of the alias to create/update

Request body

collection_namestring required

Name of the collection you wish to map the alias to

Response

The collection alias was created/updated

namestring required

Name of the collection alias

collection_namestring required

Name of the collection the alias mapped to