Skip to main content

Authorization

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

Dremio

Prerequisites​

To connect Nexla to Dremio, you need a Personal Access Token (PAT) generated from your Dremio account, as well as the base URL of your Dremio instance.

About Dremio Personal Access Tokens​

Personal Access Tokens are randomly-generated tokens associated with a specific Dremio user account. They are used in place of a password to authenticate with the Dremio REST API and other programmatic interfaces. PATs are valid for up to 180 days (configurable at token creation time) and are the recommended authentication method for REST API integrations such as Nexla.

When Nexla connects to Dremio using a PAT, all API calls are made as the user who generated the token. Ensure the Dremio user account has the necessary permissions to access the catalog entities, datasets, spaces, and views that Nexla will read from or write to.

Obtain Your Dremio Base URL​

The base URL is the root URL of your Dremio deployment. Its format depends on how your instance is hosted:

  • Dremio Cloud: https://api.dremio.cloud

  • Self-managed Dremio Software: The URL is typically the hostname and port where your Dremio instance is accessible, for example https://dremio.example.com or https://dremio.example.com:9047.

Contact your Dremio administrator if you are unsure of the correct base URL for your deployment.

Generate a Dremio Personal Access Token​

  1. Sign in to your Dremio instance using your user credentials.

  2. Click your user initials or avatar in the bottom-left corner of the Dremio console navigation bar.

  3. Select Account Settings from the menu.

  4. In the Account Settings sidebar, select Personal Access Tokens.

  5. On the Personal Access Tokens page, click the Generate Token button in the upper-right corner of the screen.

  6. In the Generate Token dialog, enter a descriptive label for the token in the Label field. Choose a label that identifies the integration purpose, for example Nexla Integration.

  7. Enter the number of days the token should remain valid in the Lifetime field. The default is 30 days and the maximum is 180 days.

  8. Click Generate Token to create the PAT.

Important

Copy the generated token immediately and store it in a secure location. Dremio displays the token only once—it cannot be retrieved after you close the dialog. If the token is lost, you must generate a new one.

Additional details about managing Personal Access Tokens are available in the Dremio Authentication documentation.

Create a Dremio Credential​

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

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 to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Dremio API Key Authentication​

Nexla connects to Dremio using a Personal Access Token (PAT), which is transmitted as a Bearer token in the Authorization request header for all API calls.

  1. Enter the base URL of your Dremio instance in the Base URL field. This should be the root URL without a trailing slash (e.g., https://dremio.example.com or https://api.dremio.cloud).

    The base URL is used by Nexla to construct all Dremio API endpoint URLs, so it is important that it matches your deployment exactly. For Dremio Cloud, use https://api.dremio.cloud. For self-managed deployments, use the fully qualified hostname and port configured for your Dremio instance.

  2. Enter your Dremio Personal Access Token in the Personal Access Token field. This is the PAT generated in the Dremio Console under Account Settings > Personal Access Tokens, as described in the Prerequisites section above.

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.