clients

openwaf-cloud ctl clients commands to list, add, change and delete an agency's end clients, and assign zones to them.

On this page

Clients are an agency's end customers. Zones, members and tokens can belong to one client, which limits what they see. These changes are audited; they are not simulated by the API, so --dry-run only prints what would be sent.

<client> is the client's name (case-insensitive) or id.

clients list

clients list [--json]

The organisation's clients with their contact e-mail, number of zones, note and id.

clients add

clients add <name> [contact_email=…] [note=…] --reason "…"
openwaf-cloud ctl clients add "Example Shop" [email protected] note="Retainer 2026" --reason "New client"

clients set

clients set <client> [name=…] [contact_email=…] [note=…] --reason "…"

Changes the fields you give.

clients rm

clients rm <client> --reason "…"

Deletes a client that has no zones. Its members, invitations and tokens limited to it go with it.

Assign a zone to a client

Use zones set-client:

openwaf-cloud ctl zones set-client example.com "Example Shop" --reason "Belongs to Example Shop"
openwaf-cloud ctl zones set-client example.com - --reason "No client"

Last updated:

↑↓ to navigate↵ to openesc to close