Administration on the command line

Administration runs through the program file itself. The commands execute before the web host and then exit — the running service does not have to be stopped for them.

cd "C:\Program Files\Invoiceflair\Portal"
Invoiceflair.Api.exe <command> [arguments]

The commands

Command	Purpose
version	version, build date, program path and the data root in use — where every support enquiry begins
list-tenants	the installation’s tenants: ID, plan, member count, creation date, name
create-owner <email> --password <pw> [--must-change]	create an account and its tenant (first access without a mail route)
set-password <email> --password <pw> [--must-change]	set the password of an existing account (support, emergencies, lifting a lockout)
set-plan <tenantId|owner-email> <token>	set a tenant’s plan. Every change appears in that tenant’s activity log
create-key <name> [--monthly-limit N]	create an API key — the plaintext appears once and cannot be recovered
list-keys	name, creation date, monthly limit, status. Never the secret
disable-key <name> / enable-key <name>	block or release; the service picks it up within 15 seconds without a restart
delete-key <name>	delete
usage [--days N] [--key <name>]	a usage report: total calls, success and failure, unique addresses, the distribution per tool and per key

The trap that strikes silently

--content-root <path> is mandatory when not starting from the installation directory

The switch determines the reference point for data/, keys/ and usage/. Without it the current directory applies — and the command line creates a second, empty database there instead of opening the installed one.

The failure is silent: list-tenants then simply shows nothing, which looks like an empty installation. That is why every investigation starts with version — it states the data root actually in use.

On set-plan in an Enterprise installation

The plan limits do not apply there in any case; every tenant counts as unlimited. set-plan is therefore mainly of interest for test setups and migrations back.

Related pages

Topic	Page
the first account without a mail route	First run
what usage reports on	Monitoring
keys from a tenant’s perspective	API keys