Branding

Present the panel as your own product - logo, colours, hostname, nameservers and emails.

In preview branding version 0.1.0

Actions

27 actions, callable from the panel, the command palette and the API as POST /api/v1/a/<id>. Internal actions used between modules are not listed.

ActionWhat it doesRiskPreview
branding.brand.list List brands (read) low No dry run
branding.brand.get Get a brand (draft and published) (read) low No dry run
branding.brand.update Save a brand draft medium No dry run
branding.brand.publish Publish a brand medium
branding.brand.revert Revert a brand to an earlier version medium
branding.brand.versions List a brand's versions (read) low No dry run
branding.asset.upload Upload a logo, favicon or sign-in background medium No dry run
branding.host.list List panel hostnames (read) low No dry run
branding.host.add Add a panel hostname high
branding.host.verify Check a panel hostname now medium No dry run
branding.host.remove Remove a panel hostname high
branding.nameserver.get Get private nameservers (read) low No dry run
branding.nameserver.set Choose private nameservers high
branding.nameserver.apply Apply nameservers to zones high
branding.nameserver.check Check delegation (read) low No dry run
branding.nameserver.pool.list List the approved nameserver pool (read) low No dry run
branding.nameserver.pool.set Set the approved nameserver pool medium No dry run
branding.template.list List email templates (read) low No dry run
branding.template.get Get an email template (read) low No dry run
branding.template.update Save an email template medium No dry run
branding.template.reset Reset a template to the default medium
branding.template.preview Preview a template with sample data (read) low No dry run
branding.template.test Send a test email medium No dry run
branding.page.list List error, suspension and parked pages (read) low No dry run
branding.page.update Save an error, suspension or parked page medium No dry run
branding.page.preview Preview a customer-facing page (read) low No dry run
branding.entitlement.check Is white-label licensed (read) low No dry run

Permissions and limits

Permissions

  • branding.view See brands and templates
  • branding.manage Edit and publish brands, templates and pages
  • branding.hosts Manage panel hostnames
  • branding.nameservers Manage private nameservers
  • branding.admin Branding administration (nameserver pool, internal reads)

Plan limits

  • branding.hosts Panel hostnames

Engineering notes

Generated from modules/branding/docs.md at build d90e9e2. These are the notes the engineers keep next to the code: precise, technical, and honest about what is not done yet.