Skip to main content
These commands cover settings that belong to the whole workspace. For fields and response details, see the API reference for themes, webhooks, IP restrictions, custom domains, API keys and audit logs.

List themes

This command lists the themes you can use, including the ones that come with NeetoForm. Use this to find a theme’s ID.
Sample output (--json)

Show a theme

This command shows one theme with all its properties.
Required arguments:
  • <id> - The theme’s UUID, from neetoform themes list

Create a theme

This command creates a workspace theme. Use this when you want your own colors and fonts. Start from another theme with --base-theme-id, or from the default theme when you leave it out.
Pass --property once for each property. To keep the values in a file, use --json-file with a file like this. Flags override the file.
Only the property keys listed for --property can be set. Any other key is rejected.

Update a theme

This command changes a workspace theme. Only the fields you pass change. Themes that come with NeetoForm cannot be changed.
Required arguments:
  • <id> - The theme’s UUID, from neetoform themes list

Delete a theme

This command deletes a workspace theme. It runs at once and does not ask first. Themes that come with NeetoForm cannot be deleted.
Required arguments:
  • <id> - The theme’s UUID, from neetoform themes list
Sample output

List webhooks

This command lists the webhooks that fire for the whole workspace.
Sample output (--json)

Show a webhook

This command shows one webhook.
Required arguments:
  • <id> - The webhook’s UUID, from neetoform webhooks list

Create a webhook

This command creates a workspace webhook. NeetoForm calls your endpoint when a submission arrives.
The secret is saved but is never shown again, so keep a copy.

Delete a webhook

This command deletes a webhook. It runs at once and does not ask first.
Required arguments:
  • <id> - The webhook’s UUID, from neetoform webhooks list
Sample output

List form webhooks

This command lists the webhooks of one form.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list

Create a form webhook

This command creates a webhook that fires for one form only.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list

Show IP restrictions

This command shows whether the workspace only accepts traffic from certain IP ranges, and lists the allowed ranges. You can only read this setting from the CLI.

List custom domains

This command lists the custom domains of your workspace.

Show a custom domain

This command shows one custom domain with its setup status and the DNS records to create. Use this after create to check if the domain is ready.
Required arguments:
  • <hostname> - The domain name, from neetoform custom-domains list
Sample output (--json)
Create a CNAME record that points the hostname to dns_target. For a root domain, create an A record that points to dns_target_ip.

Add a custom domain

This command adds a custom domain. Add the DNS records it shows, then run custom-domains show to check the status.
Required arguments:
  • <hostname> - The domain name to add

Remove a custom domain

This command removes a custom domain. Forms stop opening on that domain, so any link that uses it breaks. It runs at once and does not ask first.
Required arguments:
  • <hostname> - The domain name, from neetoform custom-domains list
Sample output

List API keys

This command lists the API keys of your workspace. Use this to find a key’s ID, or pass --search to filter by the key label. The key value itself is never shown.

Revoke an API key

This command revokes an API key. Anything that uses the key stops working at once, and this cannot be undone. The command does not ask first.
Required arguments:
  • <id> - The API key’s UUID, from neetoform api-keys list
Sample output

List audit logs

This command lists the audit log of your workspace, newest first. Use this to see who changed what. Limit it to a period with --created-after and --created-before.
Sample output (--json)