Skip to content

Configuration >> API Keys

API Keys

API Keys allow you to interact with Nullafi Shield via its API endpoints, enabling efficient configuration management and automated data analysis.

Step-by-Step Guide

Step 1: Access the API Key Generation

  • Log in to your Nullafi Dashboard using your credentials.
  • Navigate to the Configuration section from the main menu or dashboard.
  • Click on API Keys.

Step 2: Generate API Keys

  1. Inside the API Keys settings, click the Generate API Key button.
  2. Choose a meaningful name for your key, the duration for which it will be valid, and what permissions it will have.
  3. Click Generate API Key.

Step 3: Save API Keys Securely

Once the API key is generated, you will see it displayed on the screen. This is your secret key for accessing Nullafi Shield via the API. Copy and store it immediately before clicking on the Close button.

Important

Nullafi Shield does not store your API keys. It is your responsibility to save the API key securely. We recommend using a secure password manager or a secure storage solution to keep track of your API keys.

Do not share your keys with unauthorized users.

Deleting an API Key

  1. Go to the API Keys section under Configuration.
  2. Locate the key you wish to delete.
  3. Click the Delete button (the trash can icon).
  4. Confirm the deletion when prompted.

Using Your API Keys

With your API keys securely stored, you can now use them to authenticate API requests made to Nullafi Shield.

The API documentation is embedded in the Shield instance. You can access it by visiting:

https://<Shield hostname or IP>/swagger/index.html

Or, from the Admin Console, navigate to: Configuration → API Keys → API Documentation

Best Practices

  • Limit the number of API keys generated.
  • Rotate API keys periodically.
  • Use secure storage solutions.
  • Monitor usage and revoke keys when no longer needed.