kasapi-cli.md

kasapi-cli

Command-line client for the All-Inkl KAS API

Synopsis

kasapi-cli is a command-line client for the All-Inkl Kunden-Administrations-System SOAP API.

kasapi-cli [flags]

Options

      --audit-log string                 append a JSON-Lines audit record for each write action to this file (also KAS_AUDIT_LOG); a logfmt line always goes to stderr regardless
      --auth-data string                 KAS auth data (overrides config and KAS_AUTHDATA)
      --auth-type string                 KAS auth strategy: 'plain' = send password on each KasApi call (no KasAuth, no 2FA support); 'session' = bootstrap via KasAuth and reuse the credential token. Overrides config and KAS_AUTHTYPE.
      --config string                    path to the kasapi-cli config file (overrides the default location)
      --dry-run                          preview a destructive command's KAS request (action + redacted parameters) and exit 0 without dispatching or prompting; honours --output
  -h, --help                             help for kasapi-cli
      --login string                     KAS login (overrides config and KAS_LOGIN)
      --otp string                       2FA one-time PIN — sent to KasAuth as session_2fa during the credential-token bootstrap. Requires auth_type=session; the KAS API does not document 2FA on direct kas_auth_type=plain calls.
  -o, --output string                    output format: json|yaml|table (default table)
      --profile string                   profile to select from the config file (overrides default_profile)
      --session-lifetime int             session_lifetime in seconds passed to KasAuth (1..30000); 0 keeps the server default. Requires auth_type=session.
      --session-update-lifetime string   session_update_lifetime passed to KasAuth ('Y' = sliding window, 'N' = fixed). Empty omits the parameter. Requires auth_type=session.
  -v, --verbose                          enable verbose logging on stderr
  -y, --yes                              skip confirmation prompts on destructive operations

SEE ALSO

• kasapi-cli accounts - Inspect KAS accounts owned by the authenticated login
• kasapi-cli completion - Generate the autocompletion script for the specified shell
• kasapi-cli config - Inspect and bootstrap the kasapi-cli configuration
• kasapi-cli cronjobs - Inspect and manage cronjobs (get/add/update/delete_cronjob)
• kasapi-cli databases - Inspect and manage databases (get/add/update/delete_database)
• kasapi-cli ddnsusers - Inspect and manage DDNS users (get/add/update/delete_ddnsuser)
• kasapi-cli directoryprotection - Inspect and manage directory (htaccess) protections (get/add/update/delete_directoryprotection)
• kasapi-cli dns - Inspect DNS records for a zone
• kasapi-cli domains - Inspect domains owned by the authenticated account
• kasapi-cli ftpusers - Inspect and manage FTP users (get/add/update/delete_ftpuser)
• kasapi-cli mail - Inspect mail accounts and filters; inspect and manage forwards and mailing lists
• kasapi-cli sambausers - Inspect and manage Samba/CIFS users (get/add/update/delete_sambauser)
• kasapi-cli server - Inspect the host server kasapi-cli is talking to
• kasapi-cli sessions - Manage KAS session tokens (delete_session)
• kasapi-cli softwareinstalls - Inspect installable software templates (get_softwareinstall)
• kasapi-cli subdomains - Inspect subdomains owned by the authenticated account
• kasapi-cli tlds - Inspect the catalog of registrable top-level domains
• kasapi-cli usage - Inspect webspace and traffic counters