EAPI — Local Command-Line API
Use the Eenos local read-only command-line API for account, reseller, package, domain, version and migration discovery in YAML or JSON.
EAPI is the installed local, read-only command-line API at /usr/bin/eapi. It reads Eenos account, reseller, package and domain configuration and migration discovery data. It does not create, suspend or remove hosting accounts, generate SSO links or launch a migration.
Requirements and authorization
Run on an Eenos server as effective OS user root or eenos. Authorization checks the process effective UID against root or the installed eenos account. An ordinary hosting user is not authorized. Help is also checked after OS authorization.
There is no API URL, listening port, HTTP authentication header, API Manager password or hosting password argument. EAPI reads server-wide records; it does not apply the HTTP Reseller API's tenant scope. Keep output in the authorized local integration context. The old login command is not part of the current parser, and userinfo reads a record rather than validating a password.
The examples assume EAPI is already installed with Eenos. They do not install a separate package or change permissions. If the binary is missing or a source server has older commands, check its installed Eenos version and update through your normal Eenos maintenance process; a Python library directory alone does not prove that the entry-point binary exists.
Syntax
/usr/bin/eapi COMMAND [arguments] [--json | --yaml]YAML is the default; use JSON for integrations. Format flags can appear before or after the command. They are mutually exclusive, and option abbreviations are disabled. An authorized invocation without arguments displays help and exits successfully. -h/--help shows global or command help.
/usr/bin/eapi --help
/usr/bin/eapi userinfo --help
/usr/bin/eapi --json listaccounts
/usr/bin/eapi dominfo example.com --yamlCommands
| Command | Purpose |
|---|---|
| listaccounts | Full stored account records, computed state flags and recorded disk usage. |
| listreseller | Summaries of accounts with reseller registry records. |
| listpackages | Full package mappings, including default packages. |
| userinfo | Full stored mapping for one account; requires --user. |
| dominfo | Stored domain mapping with automatic owner lookup or explicit --user. |
| version | Raw installed Eenos version. |
| migrationinfo | Schema-versioned inventory for Eenos migration discovery. |
Every command reference includes Shell/Python/PHP examples and actual response structure. Account/package mappings can contain additional installation-specific fields. EAPI inventories filter eligible registry filenames to lowercase letters/underscores first, then lowercase letters, digits, underscores or hyphens; unrelated filenames are not account entries.
Integration contract
Check both the process exit code and structured status. Success uses the string ok, failure the string failed; these are not HTTP status numbers. Exit 0 means success, 1 a command/data failure, and 2 invalid arguments or insufficient privileges. Help output is plain text rather than the normal structured envelope.
Use argument-array subprocess APIs as shown in the command pages. Run them in an already authorized local worker; they do not grant privileges. Do not build shell commands by concatenating user input. Python examples use a timeout; PHP examples require an external worker/runtime deadline. Read output and error handling before consuming inventories in automation.
For HTTP integrations, use the separate WAP API or Reseller API references.