Guide | API Key
What is an API Key?
- A secret authentication key required to access a cluster. You must create one before creating a cluster.
- You must pass the key on SDK to access cluster resources.
- The full value will be shown only once at creation and cannot be retrieved later. Copy it to a secure place or save the API key file (.txt) when generated.
Notes
- You can create, regenerate, and delete your API key.
- An API key must be generated beforehand in order to create a cluster.
- Even if you regenerate your API key, you can still access clusters that were previously created.
How to use (enVector SDK)
- When connecting to a cluster with the enVector SDK, set access_token to the API Key value.
Features
- Generate Key: Generates API Key. After creation, you can copy the full key value from the "API Key Generated" modal or download it as a .txt file.
- Regenerate Key: Creates a new API key to replace the existing one.
- Delete Key: Deletes the generated API key.