API Keys

The API Keys section allows administrators to create, view, edit, and manage secure API keys for authenticated system integrations. Each key can be restricted by IP address and toggled on or off individually.

Overview

URL: /admin/api-keys

This page provides a searchable and paginated table of all existing API Keys.

Table Columns

• Name – A user-defined name for the API Key (e.g., "AdminBolt").
• API Key – The public token used for authentication.
• API Secret – The private secret used alongside the key. This value is hidden by default.

Table Features

• Search – You can search the list using any of the following fields:
  • Name
  • API Key
  • API Secret
• Pagination – A dropdown at the bottom of the table allows you to select how many results to display:
  • 5, 10, 25, 50, or All results per page.

Actions

• Create API Key – Opens a modal form for creating a new key.
• Edit – Opens the edit modal for an existing key.
• Delete – Permanently removes the selected key.

Create/Edit API Key

The modal form for creating or editing an API key is divided into two sections: API Key Details and Security Settings.

API Key Details

• Name* – A friendly label for the key.
• API Key – Generated automatically and used for authentication.
• API Secret – Also generated automatically.

Security Settings

• API Key Enabled – Toggle to activate or deactivate the key.
• IP Restriction – Toggle to enable IP restriction.
  • Whitelisted IPs – A list of IP addresses from which requests will be accepted.
    • Format: Add one or more IPs using the input field.

Footer Actions

• Create – Saves the API Key and closes the modal.
• Create & create another – Saves the key and reopens the form.
• Save Changes – Updates the existing key.
• Cancel – Closes the modal without saving.

Notes

• Security Tip: Use IP restrictions whenever possible for enhanced protection.