canvas external-tools
canvas external-tools¶
Manage external tools (LTI)
Synopsis¶
Manage Canvas external tools (LTI integrations).
External tools allow you to integrate third-party tools and services with Canvas.
Examples:
canvas external-tools list --course-id 123
canvas external-tools get 456 --course-id 123
canvas external-tools create --course-id 123 --name "My Tool" --url https://tool.example.com
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")
--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 external-tools create - Create an external tool
- canvas external-tools delete - Delete an external tool
- canvas external-tools get - Get an external tool
- canvas external-tools launch - Get sessionless launch URL
- canvas external-tools list - List external tools
- canvas external-tools update - Update an external tool