Neurelo Build Docs
Neurelo Build Docs
  • Introduction
    • Core Concepts
    • Key Features
  • Getting Started
    • Sign-in/Sign-up
    • Dashboard
      • Collapsible Sidebar
      • Light/Dark Mode
      • Account Settings
      • Audit Events
      • User Management
        • Permissions (Member v/s Admin)
      • Org Settings
    • Starting your Neurelo Project
      • Quick Start Guide
      • Step 1 - Add a Data Source
      • Step 2 - Build Definitions
      • Step 3 - Create an Environment
      • Step 4 - Create an API Key
      • Step 5 - Start Runners
      • Try your Neurelo APIs
  • "How to" Videos
    • Product Overview
    • Neurelo APIs & SDKs
    • Project Setup
    • Definitions
    • Environments
    • Data Sources
    • Organization Management
    • Creating and Using Custom Queries
    • Using the Schema Builder to build Relationships
    • Mock Data Generation
  • Definitions
    • Neurelo Schema Editor
      • Schema Builder
      • JSON/YAML Editor
      • Schema Visualization: Entity-Relationship Diagram (ERD)
    • Custom APIs for Complex Queries
      • Write and Commit Custom Queries
      • AI-Assisted Query Generation
      • Deploying Custom API Endpoints
      • Using Variables in your Custom Query
    • Branches and Commits
    • API Docs
  • Environments
    • Creating a new Environment
    • API Playground
    • Observability
    • Migrations
    • API Keys
  • Data Sources
    • PostgreSQL
    • MySQL
    • MongoDB
  • Guides
    • Provisioning Cloud Databases for using with Neurelo
      • PostgreSQL
        • AWS RDS (PostgreSQL)
      • MySQL
        • AWS RDS (MySQL)
      • MongoDB Atlas
    • Mock Data Generation
    • Wipe Data Source
    • Remote Git Repository for Definitions
      • Connecting a Remote Git Repo
      • Creating Commits from Neurelo
      • Syncing Branches
    • Data Viewer
    • Environment/Data Source Tags
    • How to work with Embedded documents and References in MongoDB
    • How to download and use the Postman Collection for your Project
    • Building Python applications with Postgres and FastAPI
    • CI Integration using Neurelo CLI
    • Schema Migrations
    • Schema AI Assist
    • Auto-Introspection
    • Access Policies
    • User Auth
      • Google
      • GitHub
      • GitLab
    • MongoDB Atlas - Migrate GraphQL to Neurelo
    • MongoDB Atlas - Migrate REST Data APIs to Neurelo
  • MongoDB Atlas - Migrate REST Data APIs to Neurelo
  • MongoDB Atlas - Migrate GraphQL APIs to Neurelo
  • Neurelo Schema Language (NSL)
    • Example 1 - DVD Rentals
    • Example 2 - Simple "Posts" App
    • Example 3 - Bookstore
  • Neurelo API Reference (REST)
    • Examples of Neurelo Auto-Generated REST API endpoints
      • Example 1 - Simple “Posts” application
      • Example 2 - "DVD Rentals" application
      • Example 3 - "Bookstore” application
      • cURL API Examples
  • Neurelo API Reference (GraphQL)
  • SDKs
    • TypeScript / JavaScript SDK
    • Go SDK
    • Python SDK
      • Python SDK Tutorial -- News Application
        • News Application using Neurelo’s Python SDKs
  • CLI (Preview Version)
  • Self-Hosted Neurelo Gateways
  • Tutorials
    • Building a Real Time Chat Application with Neurelo and MongoDB using Python
    • Building A Financial Terminal with Neurelo and MongoDB in Rust
    • Building a Restaurant Management System with Neurelo and MongoDB using GraphQL in just a few minutes
    • Bringing Neurelo’s Data APIs to Life Instantly with MySQL
  • Project Examples
  • References
    • Supported Databases
    • Supported OS and Browsers
  • Support
Powered by GitBook
On this page
  • Overview
  • Creating an API Key in Neurelo
  1. Getting Started
  2. Starting your Neurelo Project

Step 4 - Create an API Key

PreviousStep 3 - Create an EnvironmentNextStep 5 - Start Runners

Last updated 1 year ago

Overview

In Neurelo, an API Key is a security credential that grants permissions to access the APIs for a specific environment. It serves as a form of authentication, allowing applications or users to make authorized requests to the API. API Keys are included in API requests to verify the identity and permissions of the requester. These api keys help ensure secure and controlled access to the API's functionality and data.

Step 4 of the onboarding flow is to create an api key within the newly created environment.

Creating an API Key in Neurelo

Creating an api key is a vital step as part of activating an environment, especially when working with API endpoints. This key is used for securing and authorizing your API interactions, and passed with the API requests. Here’s how to create one:

  1. Initiating API key Creation:

    • On the Quickstart dashboard, find the section for "Create an API Key"

    • Click on the "New API Key" button. This action will open a prompt for api key creation.

  1. Configuring API Key Details:

  • API Key Name: You will be asked to provide a name for your new api key. Choose a name that is indicative of its use or purpose.

  • Permission Selection: Decide the level of permission for the api key. The options are:

    • Read: This permission is always pre-selected and mandatory, allowing the api key to read data.

    • Write: Optionally, you can also enable the "Write" permission if the api key is needed to modify or add data. This selection depends on your project requirements.

  1. Generating the API Key:

  • After selecting the necessary options and filling in the information, click on "Create."

  • A new prompt will appear with an important alert message: "Store this private key securely - For security reasons, you won't be able to view it again in your Neurelo Account. If you lose this secret key, you'll need to generate a new one."

Please make sure to copy and save this api key in a secure location. Neurelo does not save this key and it cannot be retrieved again from the Neurelo dashboard once this step is completed.

  1. Copying Your Generated API Key:

  • The prompt will display your "Generated API Key"

  • You can either manually "Select and Copy" or click on the "Copy" button next to the field with they api key to copy it to your clipboard.

  • Below the api key, you’ll also see the permissions associated with it.

  1. Completing the Process:

  • Once you have securely copied and stored the API Key, click on "Close" to return to the Quickstart dashboard.

The "Close" option in the dialog box will not be activated until the api key has been "Copied"

Creating and securely storing this API Key is crucial for your project’s security and functionality in Neurelo. Ensure that the api key is kept in a secure location, as you cannot retrieve the existing key again from Neurelo for security reasons. If the key is lost, you need to revoke the existing api key and issue a new one within the Neurelo account. The Quick Start dashboard will now look something like this.

We are almost at the end of the quick start. The final step (Step 5) would be starting the runners in the environment.