Skip to Content
Browse documentation

listreseller — EAPI

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

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

Returns summaries for reseller registry filenames: username, domain, owner, is_reseller and suspended. Unlike listaccounts, these are summaries rather than complete account mappings. Each eligible reseller needs a readable corresponding hosting-user record. Results are sorted by registry filename. An empty reseller directory returns an empty array; an unreadable or malformed record fails the command.

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 listreseller --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": "listreseller",
  "message": "Resellers retrieved successfully",
  "data": {
    "resellers": [
      {
        "username": "exampleuser",
        "domain": "example.com",
        "owner": "root",
        "is_reseller": true,
        "suspended": false
      }
    ]
  },
  "meta": {
    "count": 1
  },
  "error": null
}

data.resellers is an array of summaries. username, domain and owner identify the account; is_reseller and suspended are booleans. meta.count is the number of reseller filenames.

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.