How to Generate an API Token for cPFence, and Is It Required?

The cPFence API token must be generated in your Enhance Control Panel. Follow the steps below to create one:

Step 1: Generate Token in Enhance CP

  1. Log in to your Enhance Control Panel.
  2. Navigate to Settings → Access tokens → Create Token.
  3. Set the role to Super admin.
  4. Optional: Restrict the token to your Main CP IP for security. (You may need to add the IPv6 address as well to the restriction. If it still fails after that, the best approach is to leave the IP restriction off)

Note : The key is stored locally on your server in encrypted form, and even root user can’t view it once saved.

Step 2: How the API Token Is Used

The API key is stored locally on your server in an encrypted and secure way. It is only used by the ApiMachine module.

Step 3: Is It Required?

The API token is only required if you plan to use the ApiMachine module. If you are not using this module, you can skip generating an API token entirely.

 


Need Further Assistance?

If you encounter any issues generating or using the API token, please reach out to our support team via your client portal.

 

  • api, token
  • 0 A felhasználók hasznosnak találták ezt
Hasznosnak találta ezt a választ?

Kapcsolódó cikkek

How to Bulk Enable DKIM Using cPFence ApiMachine?

cPFence offers a powerful, browser-based WebUI for managing your Enhance cluster. The WebUI is...

How to Bulk Enable DNSSEC Using cPFence ApiMachine?

cPFence offers a powerful, browser-based WebUI for managing your Enhance cluster. The WebUI is...

How to Bulk Enable Force SSL Using cPFence ApiMachine?

cPFence offers a powerful, browser-based WebUI for managing your Enhance cluster. The WebUI is...

How to Bulk Enable Redis Caching Using cPFence ApiMachine?

cPFence offers a powerful, browser-based WebUI for managing your Enhance cluster. The WebUI is...

How to Bulk Generate Mail SSL Certificates Using cPFence ApiMachine?

cPFence offers a powerful, browser-based WebUI for managing your Enhance cluster. The WebUI is...