band sip realm update

Update a SIP realm's default flag or description

Synopsis

Updates a realm. Two fields are updatable: --default=true promotes the realm to the account default, and --description replaces its description. Promotion exists so a default realm can be torn down: the API refuses to delete the default realm, and 'default' can only be set to true, so another realm must be promoted first. --description is the remediation 'sip realm create --if-not-exists' names when an existing realm's description differs from what was requested. Omitted fields are preserved (the update is read-modify-write over the API's full-replace PUT).

band sip realm update <realm-id-or-name> [flags]

Examples

  # Promote a realm to account default
  band sip realm update backup-realm --default=true

  # Change only the description (default flag is preserved)
  band sip realm update vapi --description "Vapi production trunk"

Options

      --default              Make this realm the account default (only true is supported by the API)
      --description string   Set the realm's description
  -h, --help                 help for update

Options inherited from parent commands

      --account-id string    Bandwidth account ID (overrides config)
      --environment string   API environment: prod, test (overrides config)
      --format string        Output format: json or table (default "json")
      --plain                Simplified flat JSON output (recommended for scripts and agents)

SEE ALSO

• band sip realm - Manage SIP authentication realms