Skip to content

canvas config account

canvas config account

Set the default account ID for an instance

Synopsis

Set or auto-detect the default account ID for a Canvas instance.

The default account ID is used when API calls require an account ID but none is specified.

Examples:

# Set account ID manually
canvas config account production 1
canvas config account staging 42

# Auto-detect account ID (fetches accounts from API)
canvas config account production --detect
canvas config account --detect              # Uses default instance
canvas config account [instance-name] [account-id] [flags]

Options

      --detect   Auto-detect account ID from Canvas API
  -h, --help     help for account

Options inherited from parent commands

      --as-user int       Masquerade as another user (admin feature, requires permission)
      --columns strings   Select specific columns to display (comma-separated)
      --config string     config file (default is $HOME/.canvas-cli/config.yaml)
      --dry-run           Print curl commands instead of executing requests
      --filter string     Filter results by text (case-insensitive substring match)
      --instance string   Canvas instance URL (overrides config)
      --limit int         Limit number of results for list operations (0 = unlimited)
      --no-cache          Disable caching of API responses
  -o, --output string     Output format: table, json, yaml, csv (default "table")
      --show-token        Show actual token in dry-run output (default: redacted)
      --sort string       Sort results by field (prefix with - for descending, e.g., -name)
  -v, --verbose           Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 25-Jan-2026