Part 2 - Firewall Configuration Guide¶
This guide will walk you through the process of creating and configuring a firewall in the Defnese API Dashboard.
Prerequisites¶
- Completed Sign-Up Process
- Access to the Defense API Dashboard
Step 1: Add a Provider¶
- The first thing you have to do is to register a provider.
- Therefore, navigate to the providers section by clicking "Providers" in the left sidebar or by following this link.
- Fill in the required fields for the provider:
- Name: Enter a unique name for the provider (e.g., "my-openrouter-1").
- Type: Choose the provider type (e.g., "OpenAI", "mistral").
- Base URL: Add the base URL of the provider.
- API Key: Enter the API key for authentication.
- Click "Save" to add the provider.
Step 2: Create a New Firewall¶
- Go back to the "Firewalls" section firewalls.
- Click the "Add Firewall" button.
- Fill in the firewall details:
- Name: Give your firewall a descriptive name.
- Protection: Activate certain defense mechanisms for this Firewall (e.g., system prompt checking, tool call securing)
- Click "Save" to create the firewall.
- Assign a Provider: Select the provider you added in Step 1.
Step 3: Test the Firewall¶
- Once the firewall is created, locate your newly created firewall card.
- Click the "+" (plus) icon on the firewall card to generate a cURL snippet.
- Copy the generated cURL command and fill in the required parameters.
- Run it in your terminal to test the firewall.
- Try different requests to verify your activated defenses.
Troubleshooting¶
- Connection Issues? Double-check the provider's base URL and API key.
- Rules Not Applying? Ensure the firewall rules are correctly configured and saved.
- Need Help? Contact support for further assistance.
Next Steps¶
- Monitor the firewall's performance in the Defense API Dashboard.
- Adjust rules as needed for your security requirements.