usage

kasapi-cli usage

Per-resource usage examples for the read surface that ships today. Each page lists the most common invocations, the shape of their output, and the matching KAS-API documentation page so you can correlate the response columns with the upstream contract.

For the full, auto-generated flag and subcommand reference (one Markdown file per command, regenerated from the live command tree via make docs), see ../cli/.

For installation, configuration (TOML profiles, env vars, flag precedence), and troubleshooting (KasFloodDelay, no_auth / unknown_session recovery), see the project README.

Pages

• accounts — accounts, settings, resource quotas
• server — server-side hosting / service info
• domains — domains, subdomains, registrable TLDs
• dns — DNS records for a zone
• mail — mail accounts, forwards, filters, mailing lists
• databases — MariaDB / MySQL databases
• usage — webspace and traffic counters
• hosting — FTP / Samba users, cronjobs, directory protection, software installs, DDNS users

Safety

• destructive-writes — the confirmation contract for irreversible write commands ([y/N] prompt, --yes/-y bypass, non-interactive behaviour, exit codes).

Conventions used in the examples

• -o json / -o yaml / -o table selects the output format. Default is table.
• Login identifiers in real KAS responses look like w0000000; passwords and tokens are always redacted in the examples below.
• All commands honour the global flags documented in ../cli/kasapi-cli.md.