View Categories

API Keys

The API Keys module allows the admin to create and manage API keys for secure integration with external systems or applications. These keys are used to authenticate and control access to the IP-PBX APIs.

This section helps ensure that only authorized systems can interact with the platform.

Here, the following details are available:

  • Name – A unique name assigned to the API key for identification.
  • Active – Indicates whether the API key is enabled or disabled.
  • Allowed IPs – Specifies the IP addresses from which API access is permitted.
  • Rate Limit – Defines the maximum number of API requests allowed within a specific time period.
  • Description – A brief note describing the purpose of the API key.
  • Actions – Options to edit or delete the API key.

The admin can click on “Add New” to create a new API key.

Here, the following details need to be filled:

  • Name of the API key
  • Allowed IP addresses (for restricted access)
  • Active status (Yes/No)
  • Rate limit (to control API usage)
  • Description (optional)

Click the “Add” button to save the API key.

The admin can use this module to:

  • Secure API access using authentication keys
  • Restrict access based on IP addresses
  • Control API usage with rate limiting
  • Manage and monitor all API integrations

These records can be edited or deleted as per requirement. Regular monitoring is recommended to maintain security.