Account Setups

To get started with DataBeaver, you first need to create a DataBeaver account, if you don't have one already, or obtain credentials from your organisation's admin.

Obtaining Credential

To use DataBeaver developer's API, you'll also need to have to generate an API Key. Your API key uniquely identifies your organisation and shouldn't be exposed or committed.

For authenticating API calls, your API secret key should be sent as an Authorization header in every request you make.

Generate API Key

Complete the steps to generate a new API Key. Please note that your admin account must have sufficient permissions to be able to access the API

1. Login to the DataBeaver admin dashboard

2. Navigate to the Settings page

3. Navigate to the API Settings tab and expand "API Query (API key generation)". (Please note that your account must have integrations access to access this page)

4. Copy your API key or click the "Generate new key" button to generate a new key