Skip to main content

Get API Key

To use RushDB, you'll need an API token for authentication. Here's how to get one:

1. Create an Account​

Visit RushDB Dashboard and sign up for an account if you haven't already.

2. Create a Project​

  1. After signing in, click on "New Project"
  2. Enter a name for your project
  3. Choose your preferred region
  4. Click "Create"

3. Generate API key​

  1. In your project dashboard, navigate to the "API Keys" section
  2. Click "Generate New API Key"
  3. Give your token a name (e.g., "Development", "Production")
  4. Click "Generate Key"

4. Copy and Store Your API Key​

Your API token will be displayed only once. Make sure to:

  1. Copy the token immediately
  2. Store it securely
  3. Never commit it to version control
  4. Use environment variables or secure configuration management

Example of using environment variables:

// Load from environment variable
const db = new RushDB(process.env.RUSHDB_API_KEY);

Token Security​

  • Keep your tokens secure and private
  • Rotate tokens periodically
  • Use different tokens for development and production
  • Revoke tokens immediately if compromised

Next Steps​