canvas sis-imports create
canvas sis-imports create¶
Create a SIS import
Synopsis¶
Create a new SIS import from a CSV or ZIP file.
The file should follow the Canvas SIS import format: - CSV files for individual data types - ZIP file containing multiple CSVs
Examples:
canvas sis-imports create --account-id 1 --file users.csv
canvas sis-imports create --account-id 1 --file data.zip --batch-mode --batch-mode-term-id 123
Options¶
--account-id int Account ID (required)
--add-sis-stickiness Add SIS stickiness
--batch-mode Enable batch mode
--batch-mode-term-id int Term ID for batch mode
--change-threshold float Skip if changes below threshold (0.0-1.0)
--clear-sis-stickiness Clear SIS stickiness
--diffing-data-set-identifier string Diffing dataset identifier
--diffing-remaster-data-set Remaster diffing dataset
--extension string File extension (csv, zip)
--file string CSV or ZIP file to import (required)
-h, --help help for create
--import-type string Import type (default "instructure_csv")
--override-sis-stickiness Override SIS stickiness
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¶
- canvas sis-imports - Manage SIS imports