Skip to main content

Authorization

Follow this guide to create a new Milvus credential that will allow Nexla to authenticate to and exchange data with your Milvus instance.
milvus_api_auth.png

Milvus

Prerequisites​

Before creating a Milvus credential, you'll need to obtain authentication credentials (username and password or API key) from your Milvus deployment. Milvus supports token-based authentication for API access.

To obtain Milvus authentication credentials:

  1. Access your Milvus deployment. The Milvus host URL depends on your deployment type (self-hosted, cloud, or managed service).

  2. If you're using Milvus Cloud or a managed Milvus service, log in to your account dashboard and navigate to the API or Access Keys section.

  3. If you're using a self-hosted Milvus instance, you'll need to configure authentication through your Milvus configuration. Milvus supports username/password authentication or API key-based authentication.

  4. Create a new API key or user account for API access. For username/password authentication, ensure you have a valid username and password configured in your Milvus instance.

  5. Note your Milvus host URL. This is the endpoint URL of your Milvus service, typically in the format https://your-milvus-instance.com or http://your-milvus-instance:port for self-hosted deployments.

  6. Note the API version you'll be using. Milvus REST API typically uses version v2 for the current API version.

Milvus authentication can use either username/password credentials or API keys, depending on your deployment configuration. The credentials are used to obtain an access token via the token authentication endpoint, which is then used as a Bearer token in the Authorization header for all API requests.

For detailed information about Milvus API authentication and credential management, refer to the Milvus API Reference.

Create a Milvus Credential​

  • To create a new Milvus credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Milvus

MilvusCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Credential Settings​

  1. In the Username Or API Key field, enter your Milvus username or API key. This is used for token-based authentication to obtain an access token.

  2. In the Password field, enter your Milvus password. If you're using API key authentication, this field may not be required depending on your Milvus configuration.

    The password is sensitive information and should be kept secure. If you're using API key authentication, ensure you have the correct API key configured in your Milvus instance.

  3. In the Milvus Host field, enter the endpoint URL of your Milvus service. This should be the complete URL including the protocol (https:// or http://) and port if applicable. For example: https://your-milvus-instance.com or http://localhost:19530 for local deployments.

  4. In the API Version field, enter the Milvus API version you want to use. The default value is v2, which is the current version of the Milvus REST API. You can specify a different version if your Milvus deployment uses a specific API version.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.