userinfo — EAPI
Read a hosting account using the local Eenos command-line API, with syntax, output fields, errors and Shell/Python/PHP examples.
/usr/bin/eapi userinfoLocal read-only commandReturns the full stored mapping for one hosting account. --user is required. EAPI accepts usernames starting with a lowercase letter or underscore, followed by lowercase letters, digits, underscores or hyphens; a dollar sign is not accepted. This does not verify a hosting password or perform a login. It does not add the computed flags/disk usage supplied by listaccounts. Record fields vary by account configuration.
Command
Run locally on an Eenos server as effective OS user root or eenos. No HTTP URL, API headers, API password or hosting password is supplied. The command reads server-wide information; it is not a reseller-scoped API call.
/usr/bin/eapi userinfo --user exampleuser --json| Argument or option | Meaning |
|---|---|
--user USER | Required existing hosting username. |
--json | JSON output, used by the examples. |
--yaml | YAML output, the default when no format flag is supplied. |
-h, --help | Command help. |
Use only one output format; format flags can precede or follow the subcommand. Do not combine --json and --yaml. Options cannot be abbreviated. This command has no other declared options.
The Python example uses argument-list execution and a 30-second timeout. The PHP example requires PHP 7.4 or later for array-form proc_open (PHP 8 recommended); it bypasses shell parsing and discards stderr while validating stdout JSON and exit status. It has no built-in deadline: the integration worker must impose a process/runtime timeout. Run integrations only in an already authorized local worker context; these snippets do not grant OS privileges. Replace exampleuser/example.com where applicable.
Success output
Exit 0, with string status ok. Illustrative records and version; complete stored mappings can contain additional fields.
{
"status": "ok",
"command": "userinfo",
"message": "User information retrieved successfully",
"data": {
"contactemail": "owner@example.com",
"dedicatedip": {
"ipv4": "192.0.2.10",
"ipv6": null
},
"domain": "example.com",
"homedir": "/home/exampleuser",
"owner": "root",
"package": "starter",
"reseller": {
"selfown": "off",
"status": "on"
},
"user": "exampleuser"
},
"meta": {},
"error": null
}data is the stored account mapping itself; meta is an empty object. The CLI does not add computed listaccounts fields.
Errors
Exit 1 indicates command/data/serialization failure. Exit 2 indicates invalid CLI arguments or insufficient OS privileges. Inspect the failed envelope and error.code; these are process exit codes and symbolic errors, not HTTP status codes.
See output and error handling for all current error codes, format behavior and integration requirements. Unreadable required records are failures, not empty successful inventories. Account/package output can contain sensitive server configuration; keep it in the authorized integration context.