Skip to Content
Browse documentation

API Manager in WAP

Create Eenos administrator API accounts, restrict source IP addresses, change API passwords and delete unused API users.

Open Eenos → Preferences → API Manager to create and manage administrator API accounts for remote integrations, such as billing systems. Despite the internal route name, this page manages API usernames and passwords; it does not display generated bearer tokens.

Requirements and access precautions

Use an authenticated administrator WAP session over HTTPS. Decide which integration needs access, prepare its source IP addresses and store its credentials securely. Mutating actions are blocked in demo sessions.

Treat these credentials as root-level access

The panel's security notice warns that exposing API accounts can compromise the server. Prefer a dedicated account for each integration and restrict its allowed source addresses when possible. This page offers no per-endpoint or role-scoped permission selector.

API Accounts table

ColumnMeaning
Sl.NoRow number.
API UserAPI account username.
Date of CreationRecorded creation time.
Date of UpdateRecorded last credential update time.
Remote AccessOpen or restricted source-IP access.
Whitelisted IPsPermitted addresses for a restricted account; open accounts are shown as able to connect from any IP.
ActionChange API Password and Delete API User controls.

Use the table's search and page-length controls to find an account. An empty table reports No API accounts found; filtering can report No matching API accounts found. Existing password values are not included in the table response and cannot be retrieved here.

Create API Account fields

Field or controlRequirement and behavior
API User NameRequired and unique among these API accounts. For compatibility with browser and server rules, use 5–30 lowercase characters, begin with a letter or underscore, and use lowercase letters, digits, underscores or hyphens thereafter.
PasswordRequired. Use a long, unique credential. Show/hide and Generate password controls are provided.
Re-enter PasswordRequired and must match Password.
Remote Access: Allow any IPDefault selection. Does not impose an account-level source-IP allowlist. It does not disable authentication.
Remote Access: Allow the following IPs onlyEnables a source-IP allowlist and requires at least one valid address.
Whitelisted IPsShown for restricted access. Enter individual IPv4/IPv6 addresses separated by commas. The server also accepts newline-separated entries and ignores empty entries. CIDR ranges, hostnames and ports are not accepted as individual IP values.

The browser username hint and server validator are not identical. The compatible subset above avoids uppercase or digit-leading usernames that the server rejects. Password fields are trimmed by the form; do not rely on leading/trailing whitespace.

Create an API user

  1. Fill API User Name, Password and Re-enter Password.
  2. Select the intended access policy. For restricted access, enter the integration's actual source IP addresses, including any relevant outbound/NAT address.
  3. Select Create API User.
  4. Review the Create API Account confirmation, then select Create. Cancel leaves the account uncreated.
  5. Look for the username-specific success message and verify its table row and access policy.
  6. Store the credential in the integration and verify authorized connectivity separately.

The account stores a password hash and creation/update timestamps. Creating it does not open firewall ports or configure an API client. Continue with WAP API authentication and connection examples to test the integration's credentials.

Change an API password

  1. Find the account and select Change API Password.
  2. Check API User in the dialog and fill New Password. Visibility and generator controls are available; there is no separate confirmation-password field in this dialog.
  3. Select Change Password and review the result.
  4. Update the integration's saved password and test it.

The operation changes the hash and Date of Update for that existing account. It does not change its username or source-IP policy. Existing passwords cannot be displayed or recovered.

Delete an API user

Select Delete API User for the intended row, confirm the named account, and select Delete. Use Cancel to stop. A successful deletion removes its stored credential record. Integrations relying on it will no longer be able to authenticate with that record.

There is no undo control and no in-place edit control for the username or IP policy in this page. If replacement is needed, plan a new account and integration cutover rather than assuming password rotation edits access restrictions.

Errors and verification

  • Required fields, mismatched passwords, duplicate usernames and invalid IPs prevent creation.
  • Restricted access without a valid IP produces Please enter at least one valid IP address.
  • Demo sessions report that the operation is unavailable.
  • Create, password-change and deletion failures produce username-specific errors. Verify the table and server-side error logs before retrying; a failed write-related result does not prove no partial change occurred.
  • Attempted management actions are recorded as configuration audit events without password values in the view's audit metadata.

Do’s and don’ts

  • Do prefer explicit allowed source addresses and test the policy from the intended integration.
  • Do rotate credentials when needed and delete unused accounts after checking dependencies.
  • Do not interpret Allow any IP as a disabled API account.
  • Do not publish passwords in URLs, documentation examples, tickets or screenshots.
  • Do not delete the only working integration account without a replacement or recovery plan.

Previous: Resolver Configuration. Next: Tweak Settings.