dominfo — EAPI
Read domain configuration using the local Eenos command-line API, with syntax, output fields, errors and Shell/Python/PHP examples.
/usr/bin/eapi dominfoLocal read-only commandReturns the full stored domain mapping. The domain is a required positional argument; --user is optional. Without --user the tool resolves the domain owner through the domain registry (including parent-domain owner lookup), then reads the exact requested domain record. Resolving a parent owner does not synthesize a missing subdomain record. With --user it reads under that account directly. The domain is lowercased and trailing dots removed; path separators, NUL, dot and dot-dot targets are rejected. Use the stored DNS name, including its ASCII IDN spelling where appropriate; this command does not run the panel domain form normalization. A wrong explicit user or missing exact domain record fails.
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 dominfo example.com --json| Argument or option | Meaning |
|---|---|
DOMAIN | Required positional domain name. |
--user USER | Optional explicit account, bypassing owner lookup. |
--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": "dominfo",
"message": "Domain information retrieved successfully",
"data": {
"docroot": "/home/exampleuser/public_html",
"servername": "example.com",
"type": "website",
"user": "exampleuser"
},
"meta": {},
"error": null
}data is the stored domain mapping itself; meta is an empty object. Fields vary with website/domain configuration.
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.