Skip to main content
An API key lets your own tools use the firewall without signing in to the panel. These tools can be scripts, bots, monitoring systems or AI assistants. Each key can only do the things you allow it to do.

Difficulty

Intermediate

Time

5 minutes
You only need an API key if you want to connect another tool. You don’t need one to use the panel itself.

​
The API keys page

Click API keys in the sidebar, or go to network.freakhosting.com/api-keys.
API keys page with Total keys and Disabled counters, a search box, the Create key button and a table with Name, Prefix, Permissions, Created, Last used and Actions columns

The API keys page

​
Create an API key

1

Open the form

Click Create key.
2

Name the key

Use a name that says which tool uses it, for example Discord bot or Uptime monitor.
3

Choose the permissions

Click each permission the tool needs. Selected permissions are highlighted. See the permissions reference below for what each one does.
4

Create it

Click Create key.
5

Copy the key now

Click the copy icon and save the key somewhere safe, such as a password manager. Then click Done.
Create API key dialog with a Key name field and a grid of permission buttons grouped by resource, such as ip view, firewall view and create, and attackLog view

Choosing permissions for a new key

API key created dialog with a blurred key, a copy icon and the warning Store it securely. After you close this dialog only the prefix is visible

Your new key is shown only once

The full key is shown only once. After you click Done, only the prefix is visible. If you lose the key, revoke it and create a new one.
You can only give a key permissions that you have yourself. If a permission is missing from the list, ask the organization owner to check your role.

​
See what a key can do

In the Permissions column, click the link (for example 3 permissions). A window lists every resource and action the key has. Click Done to close it. You can’t change a key’s permissions after it is created. To change them, create a new key with the right permissions, update your tool, then revoke the old key.

​
Revoke a key

Revoke a key when you stop using a tool, or if you think someone else has seen the key.
1

Find the key

Find the key in the list. You can search by name or prefix.
2

Revoke it

Click the revoke icon in the Actions column.
3

Confirm

Click Revoke key.
Tools using the key lose access straight away. You can’t undo this.

​
Keep your keys safe

  • Use one key per tool. If a tool is compromised, you only revoke that key.
  • Give only the permissions the tool needs. A monitoring tool that only reads data needs view permissions, not create or delete.
  • Never share a key in public. Don’t paste it into Discord, forums, screenshots or public code repositories.
  • Check Last used. A key that is never used can be revoked. A key used when you didn’t expect it should be revoked straight away.

​
Permissions reference

Each permission is made of a resource (the thing the key works with) and an action (what it can do with it). For example, firewall + create lets a key add firewall filters. The same permissions are used for custom team roles and AI tools connected with MCP.
Be careful with organization → delete, member → delete, apiKey → create and ac permissions. They control who has access to your account. Most tools never need them.

​
Suggested permissions for common tools

​
Troubleshooting

The key is missing, mistyped or revoked. Check that your tool sends the header Authorization: Bearer YOUR_KEY with the full key. If you’re not sure the key is correct, create a new one.
The key works, but it doesn’t have permission for that action. Click the key’s Permissions link to check. Then create a new key with the missing permission.
Keys can’t be shown again. Revoke the old key and create a new one.
You can only grant permissions your own role has. Ask the organization owner to give you a role with that permission.

API documentation

Every endpoint, with ready-to-copy examples.

Connect AI tools (MCP)

Manage your firewall from Claude, Cursor and more.

​
Need Extra Help?

If you encounter any issues, our support team is ready to assist:

​
Save on Your Hosting

Ready to upgrade your hosting? Use code KB20 at checkout for 20% off your first order!
Last Updated: October 2026