Setting Up Your HogWarp API Key
Generate and configure the API key required for your HogWarp server to appear on the public server list.
Setting Up Your HogWarp API Key
Every HogWarp dedicated server requires a valid API key to function. Without it, the server cannot register with the HogWarp presence service and will refuse to start. This article walks you through generating a key and applying it to your server.
Why Is an API Key Required?
The HogWarp project uses a central presence server (presence.hogwarp.com) to maintain the public server list. When your server starts, it authenticates with this service using your API key. If the key is missing or invalid, the server exits immediately with an Invalid API key error.
Step 1: Log In to the HogWarp Presence Portal
- Go to https://presence.hogwarp.com/login
- Click Login with Discord and authorize the application with your Discord account
- Once logged in, navigate to the API Keys or Server section of your dashboard
Step 2: Generate Your API Key
In the portal, create a new API key for your server. Copy the full key — it will look like a long alphanumeric string. Store it somewhere safe; treat it like a password.
Note: Each API key is tied to your Discord account. If you run multiple servers, check whether the portal allows multiple keys per account or whether you need separate Discord accounts per server.
Step 3: Set the API Key on Your Server
The API key is provided to the server through the API_KEY environment variable at startup.
On DustBowl.Games (Wisp/Pterodactyl Panel)
- Open your server in the panel
- Go to Startup settings
- Find the
API_KEYvariable field - Paste your key and save
- (Re)start the server
Manual / Shell Setup
Set the environment variable before launching:
export API_KEY="your-api-key-here"
wine HogWarpServer.exe
Or inline:
API_KEY="your-api-key-here" wine HogWarpServer.exe
Troubleshooting API Key Errors
Error: Invalid API key
- Double-check you copied the full key with no extra spaces or characters
- Confirm the key is set as
API_KEY(case-sensitive) - Log back into presence.hogwarp.com and verify the key is still active — regenerate if needed
Server starts but does not appear in the list
- The key may be valid but your server's port (11778) may not be reachable. See HogWarp Port Forwarding and Firewall Setup