Skip to main content

Authorization

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

Vespa

Prerequisites​

Before creating a Vespa credential, you'll need to obtain an API key from your Vespa deployment. Vespa uses API key authentication for headless communication with Vespa Cloud control plane services, or you may need to configure authentication based on your specific Vespa deployment.

To obtain Vespa API credentials:

  1. If you're using Vespa Cloud, log in to your Vespa Cloud account at https://console.vespa-cloud.com.

  2. Navigate to your application or tenant settings in the Vespa Cloud console.

  3. In the API settings or security section, locate the option to create or manage API keys.

  4. Click Create API Key or Generate New Key to create a new API key for your application. You may need to provide a name or description for the API key.

  5. Copy the API key immediately after generation, as it may only be displayed once for security purposes. Store it securely, as you'll need it to authenticate API requests.

  6. Note your Base URL. This is the root URL for your Vespa API endpoints, including the protocol (https://) and port. For Vespa Cloud, this is typically provided in your application configuration. For self-hosted Vespa, this is your Vespa instance URL.

  7. Note your API Version. The default API version is typically v1, but this may vary depending on your Vespa deployment.

Vespa API keys are used as Bearer tokens in the Authorization header for all API requests. The API key is sensitive information and should be kept secure. If you're using a self-hosted Vespa instance, authentication may be configured differently. Consult your Vespa deployment documentation for specific authentication requirements.

For detailed information about Vespa API authentication and API key management, refer to the Vespa Document API Guide.

Create a Vespa Credential​

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

New Credential Overlay – Vespa

VespaCred.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 Base URL field, enter the root URL for the Vespa API endpoints. This must include the protocol (https://) and port if applicable. For example, https://your-vespa-instance.com:8080 or your Vespa Cloud application URL.

  2. In the Vespa API Key field, enter the API key that you obtained from your Vespa deployment. This is the authentication token for headless communication with Vespa Cloud control plane services or your Vespa instance.

  3. In the Vespa API Version field, enter the API version for Vespa API requests. The default value is v1. This field is required and should be kept secure.

    The API key is sensitive information and should be kept secure. If you've lost your API key, you'll need to generate a new one in your Vespa Cloud console or Vespa deployment settings. API keys are used as Bearer tokens in the Authorization header for all API requests.

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.