Create Agents and API Keys

This section covers how to create new Agents and API key in DataGrail.

Add New Agent

The first step in enabling RDD is to create an agent within DataGrail. Each instance of an RDD Agent will enable you to add and configure systems you’d like to connect and scan.

1. In the left-hand navigation bar under Integration Network, select Agents.
2. Select Add New Agent.
3. Enter a name for the agent that is easy to remember and that can be associated with a private network, region, types of systems, etc.
4. For Agent Type, select Data Discovery.
5. Select Add New Agent.

Create DataGrail API Key

RDD Agents securely communicates with DataGrail by using an API key that you will create and then store in your secrets vault. For more information on how to configure various credentials managers, see Agent Platform CredentialsManager.

API Keys

Once saved, API keys cannot be viewed or copied. If a key is lost, you can generate a new one.

1. Within the newly created agent’s page, select Generate API Key.
2. Give the key a convenient name.
3. Copy and securely store the API key in your secrets vault using the following format:

Secret Configuration Format

The key-value pairs must be formatted as token: API key, and all other values are only applicable for some vaults and aid in identification of secrets.

Secret Type: Other type of secret
Key/value pairs:
    token: <API Key copied above>
Secret name: datagrail-api-key
Description: <description for the secret>

If you are storing the API Key as JSON within your credentials manager, use the following structure:

{
  "token": "<API Key copied above>"
}

Best Practice

DataGrail recommends regularly rotating API keys in accordance with your policies.

It is strongly recommended that one API key be used per containerized service for security and debuggability purposes.