Access Keys

There are two main types of access keys, ingest and read keys. There is also an admin level key that may be used for self-hosted installations. By default, when a new index is launched a set of read and ingest keys are created. You may create additional keys of either type within Vektron. Keys can have access to multiple indexes and are limited to the permissions of the index they are associated with. You may revoke and regenerate keys at any time within Vektron.

Ingest Keys

Ingest keys are used to perform operations that modify data within an index. They should never be used in browser served client-side code as they are considered sensitive information and would allow anyone to modify data in the index.

Read Keys

Read keys are the keys that should be used with SDK integrations or any client-side code that may be exposed to the public. As the name implies, they have read only permissions.

Administrative Keys

If you are using the self-hosted version of Searchcraft, you can create administrative keys that have higher level permissions such as the ability to create and delete indexes and manage authentication keys. See the CLI documentation for more information.