canvas external-tools create
canvas external-tools create¶
Create an external tool
Synopsis¶
Create a new external tool in a course or account.
Examples:
canvas external-tools create --course-id 123 --name "My Tool" --url https://tool.example.com
canvas external-tools create --course-id 123 --name "LTI Tool" --consumer-key key123 --shared-secret secret123
canvas external-tools create --course-id 123 --json tool-config.json
Options¶
--account-id int Account ID
--config-type string Config type: url, xml
--config-url string Configuration URL
--config-xml string Configuration XML
--consumer-key string OAuth consumer key
--course-id int Course ID
--description string Tool description
--domain string Tool domain
-h, --help help for create
--json string JSON file with full tool configuration
--name string Tool name (required)
--privacy-level string Privacy level: anonymous, name_only, email_only, public
--shared-secret string OAuth shared secret
--url string Tool URL
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 external-tools - Manage external tools (LTI)