Skip to main content

Managing Ragapi API Keys

Ragapi uses API keys to authenticate requests to its endpoints. Here's how you can create, manage, and secure your keys effectively.

Note: API keys provide full access to your Ragapi account and resources. Handle them with care, as anyone with your key can use your account.

How to Create an API Key

  1. Navigate to the API Keys Section
    In the Ragapi app, click on API Keys in the side menu to access the API Keys management page.

  2. Create a New Key
    Click on the Create Key button. A new API key will be generated and displayed on the screen.

  3. Save Your Key Immediately
    Your API key is displayed only once, so be sure to copy and save it securely right away. If you lose it, you will need to create a new one.

Key Management Best Practices

  • Keep Keys Secure
    API keys should be treated as secrets. Do not share them publicly or commit them to source code repositories.

  • Use Environment Variables
    Store API keys in secure environment variables instead of hardcoding them in your applications.

  • Rotate Keys Regularly
    Periodically generate new API keys and remove older ones to minimize security risks.

  • Delete Unused Keys
    Delete any API keys you no longer use from the API Keys page in the app. This reduces the risk of unauthorized access.

Managing Multiple Keys

Ragapi supports multiple API keys. This is useful for different projects or environments (e.g., development, staging, production). You can create, label, and manage these keys from the API Keys page.

What to Do if Your Key is Exposed

If you suspect your API key has been exposed or compromised:

  1. Immediately delete the affected key from your Ragapi account.
  2. Generate a new key to replace it.
  3. Update your applications with the new key and ensure the old one is no longer used.

By following these guidelines, you can ensure your Ragapi account remains secure and your API keys are managed responsibly. For further details, refer to the full Ragapi documentation.