Skip to content

canvas blueprint sync

canvas blueprint sync

Sync blueprint to associated courses

Synopsis

Begin a sync of the blueprint to all associated courses.

Examples:

canvas blueprint sync --course-id 1
canvas blueprint sync --course-id 1 --comment "Weekly content update"
canvas blueprint sync --course-id 1 --send-notification --copy-settings
canvas blueprint sync [flags]

Options

      --comment string       Sync comment
      --copy-settings        Copy course settings
      --course-id int        Course ID (required)
  -h, --help                 help for sync
      --publish              Publish synced content
      --send-notification    Send notification to users
      --template-id string   Blueprint template ID (default "default")

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