Skip to Content
Browse documentation

listpackages — EAPI

List full hosting packages using the local Eenos command-line API, with syntax, output fields, errors and Shell/Python/PHP examples.

CLI/usr/bin/eapi listpackagesLocal read-only command

Returns full mappings from package files ending in .yaml, sorted by filename, including default packages. This is server-wide and is not filtered by package owner. Empty inventories return an empty array. Unreadable inventories or malformed package records fail the command rather than silently skipping packages. The nested fields depend on the installed package definitions.

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 listpackages --json
Argument or optionMeaning
--jsonJSON output, used by the examples.
--yamlYAML output, the default when no format flag is supplied.
-h, --helpCommand 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": "listpackages",
  "message": "Packages retrieved successfully",
  "data": {
    "packages": [
      {
        "name": "starter",
        "owner": "root",
        "quota": "2048"
      }
    ]
  },
  "meta": {
    "count": 1
  },
  "error": null
}

data.packages is an array of full package objects; meta.count is its length. This is not the comma-separated string returned by the HTTP listpackages endpoints.

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.