| docs

Appearance

Api Keys ​

The Api Keys page allows resellers to create and manage API keys for authenticating with AdminBolt via REST API endpoints.

Reseller Api Keys

Overview ​

URL: /reseller/api-keys

The page header reads: "Create and manage secure API keys with access control and IP restrictions."

A New api key button opens the API key creation form.

Integration Overview ​

Below the header, an integration overview section explains that API keys enable secure authentication for external applications to interact with AdminBolt via REST API endpoints.

A link to the API Documentation is provided (e.g., /api/documentation) for endpoints, authentication, and usage details.

Api Keys Table ​

The table displays all API keys created by the reseller.

Search and Filter ​

A search bar filters keys. Click the Filter button to apply advanced filters:

  • Status - Filter by status (All, Active, Inactive).
  • IP Whitelist - Filter by IP whitelist status (All, Enabled, Disabled).

A Reset button clears all filters.

Table Columns ​

  • Name - The API key name
  • API Key - The generated key value
  • API Secret - The generated secret value
  • Active - Whether the key is active

Empty State ​

When no API keys exist, the page shows "No API Keys Yet" with the message "No API Keys found. Create one to get started."

Creating an API Key ​

Clicking New api key opens a modal with the following sections:

API Key Details ​

  • Name (required) - A friendly name to identify this API key (placeholder: "Enter a descriptive name")
  • API Key (read-only) - Auto-generated API key value
  • API Secret (read-only) - Auto-generated API secret value

Security Settings ​

  • Enable API Key (toggle) - Enable or disable the API key. Default: enabled
  • IP Restriction (toggle) - Limit API access to specific IP addresses. Default: disabled

Endpoint Access ​

  • Allow all endpoints (toggle) - When enabled, this key can access every API route. When disabled, only selected endpoints and methods are allowed. Default: enabled

Form Actions ​

  • Create - Save the API key
  • Create & create another - Save and reset the form for a new key
  • Cancel - Close the modal without saving

Acting on behalf of a hosting account ​

A reseller API key can call any /api/client/* endpoint on behalf of one of your own hosting accounts, so you do not need a separate key per account. Name the account in the X-Hosting-Account header, using either its numeric id or its username:

bash
curl https://server.example:8443/api/client/domains \
  -H "X-API-Key: <your-key>" \
  -H "X-API-Secret: <your-secret>" \
  -H "X-Hosting-Account: alice"
  • The header is required. Without it, the request is refused rather than being applied to an unspecified account.
  • You can only name accounts you own. An account belonging to another reseller, or to the server administrator, is reported as not found.
  • The key's endpoint access settings apply exactly as they do on the reseller API.