canvas blackout-dates
canvas blackout-dates¶
Manage course blackout dates
Synopsis¶
Manage Canvas course blackout dates (periods excluded from pacing).
Examples:
canvas blackout-dates list --course-id 1
canvas blackout-dates get 5 --course-id 1
canvas blackout-dates create --course-id 1 --start-date 2024-12-24 --end-date 2024-12-26 --title "Winter Break"
canvas blackout-dates update 5 --course-id 1 --title "Extended Break"
canvas blackout-dates delete 5 --course-id 1
Options¶
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")
--quiet Suppress informational messages, only output data and errors
--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 - Canvas LMS CLI - Interact with Canvas from the command line
- canvas blackout-dates create - Create a blackout date for a course
- canvas blackout-dates delete - Delete a blackout date
- canvas blackout-dates get - Get a blackout date
- canvas blackout-dates list - List blackout dates for a course
- canvas blackout-dates update - Update a blackout date