2020 API Change Log Archive
The Change Log Archive page displays previous API changes from 2020 noted in the API Change Log. The heading date indicates the date that the API code was made available in the production environment.
2020-12-16
Additions
Roles API | Create a New Role Endpoint
- Added manage_wiki_create, manage_wiki_delete, manage_wiki_update values
2020-12-02
Additions
External Tools LTI Variable Substitutions
- Added Context.id.history variable
Canvas Data Services Page
- Added Canvas Data documentation
2020-11-18
Additions
Calendar Events API Controller | Get Course Timetable Endpoint
- Added events[][title] parameter
- Developer Contribution: Update documentation for CalenderEventsApiController
External Tools LTI Variable Substitutions | Enrollments CSV
- In Status field, added deleted_last_completed
Scores API | Create a Score Endpoint
- In https://canvas.instructure.com/lti/submission parameter, added submission_at value
Users API | Edit a User Endpoint
- Added user[pronouns] parameter
2020-11-04
Additions
External Tools LTI Variable Substitutions
- Added com.instructure.Observee.sisIds variable
2020-10-21
Additions
- Added Import Category Groups Endpoint
Group Category Import Format Documentation
- Added Group Category Data Format
- CompletionRequirement Object: added must_mark_done parameter
- Create a Module Item Endpoint:
- Module_item[completion_requirement][type]: added must_mark_done parameter
- Update a Module Item Endpoint:
- Module_item[completion_requirement][type]: added must_mark_done parameter
SIS Import Format Documentation | Users.csv
- Changed pronouns field to support all pronouns, even if they weren’t previously created in the Account Settings page
2020-10-07
Additions
Accounts API | TermsOfService Object
- Added self_registration_type parameter
- Added Edit a Submission Comment and Delete a Submission Comment Endpoints
Open Source Contribution: Add API endpoints to edit and delete submission comments
2020-09-23
Additions
Assignments API | Assignments Object
- Added can_submit parameter (optional)
Removals
- Deprecated Create a User Endpoint (for self-registration only)
- Deprecated Self Register a User Endpoint
Initial posting date: 2020-07-01
2020-09-09
Additions
Assignment Group API | Get an Assignment Group Endpoint
- Added score_statistics in the include[] parameter
Open Source Contribution: Add score statistics to the assignments API as an 'include' option #1669
External Tools LTI Variable Substitutions
- Added com.instructure.User.sectionnames variable
2020-08-12
Additions
External Tools LTI Variable Substitutions
- Added Canvas.assignment.lockdownEnabled variable
2020-07-27
Additions
SIS Import Format Documentation | Enrollments.csv
- Added notify parameter
2020-07-15
Removals
Users API | Create a User Endpoint
- Deprecated user[birthdate] parameter
Removal date: 2020-10-07
Browser Protocols TLS 1.0 and 1.1
- Removed support for TLS 1.0 and 1.1 protocols for web traffic.
- Users may be affected if applications are parsing page content or using a script against Canvas APIs.
- Background regarding these changes can be found in Deprecating TLS 1.0 & 1.1.
Initial Posting Date: 2020-04-18
2020-07-01
Removals
- Deprecated Create a User Endpoint (for self-registration only)
- Deprecated Self Register a User Endpoint
- Removal date: 2020-09-23
2020-06-20
Removals
Assignments API | Assignment Object
- Removed muted parameter
Initial posting date: 2020-02-26
- Changed bookmarks management to align with opaque pagination links, which helps minimize the pagination impact on the database.
- App developers relying on Canvas APIs need to update how their apps manage pagination using “rel” headers, rather than the numerical page number, as noted in Pagination - Canvas LMS REST API Documentation.
Initial posting date: 2020-02-15
2020-06-06
Additions
Calendar Events API | CalendarEvent Object
- Returns context_code parameter
Courses API | Update a Course Endpoint
- Added syllabus_course_summary parameter
List External Tools Endpoint
- Example response includes is_rce_favorite parameter
Get a Single External Tool Endpoint
- API Response Field includes is_rce_favorite parameter
Create an External Tool Endpoint
- Added is_rce_favorite parameter
External Tools LTI Variable Substitutions
- Added com.instructure.User.observees variable
2020-05-23
Additions
CommMessages API | List of CommMessages for a User Endpoint
- Added time period clarification for start_time and end_time parameters
SIS Import Format Documentation
- Added pronoun parameter
Removals
- Removed paragraph about developer key requests
2020-05-09
Additions
Enrollments API | Grade Object
- Returns current_points and unposted_current_points parameters
Enrollments API | List Enrollments Endpoint
- Added current_points as a value in the include[] parameter
Logins API | Edit a User Login Endpoint
- Added login[authentication_provider_id] parameter
- Added example request and example response
SIS Import Format Documentation | Courses.csv
- Added published as a value in the status parameter
2020-04-25
Additions
- Added Endpoint
Enrollments API | Enroll a User Endpoint
- Added enrollment[start_at], enrollment[end_at] parameters
- Added List Observers, Show an Observer Endpoints
2020-04-18
Additions
Assignments API | List Assignments Endpoint
- Added can_edit as a value in the include[] parameter
Assignments API | Get a Single Assignment Endpoint
- Added can_edit as a value in the include[] parameter
Assignment Groups API | List Assignment Groups Endpoint
- Added can_edit as a value in the include[] parameter
Blueprint Courses API | Begin a Migration to Push to Associated Courses Endpoint
- Added publish_after_initial_sync parameter
Removals
Browser Protocols TLS 1.0 and 1.1
- This change is enabled in the beta environment to allow for testing until 2020-09-18, at which time the change will be deployed to the production environment.
- Removed support for TLS 1.0 and 1.1 protocols for web traffic.
- Users may be affected if applications are parsing page content or using a script against Canvas APIs.
- Background regarding these changes can be found in Deprecating TLS 1.0 & 1.1.
2020-04-11
Additions
- Added List Conferences for the Current User Endpoint
Conferences API | Conference Object
- Returns context_type and context_id
2020-04-04
Additions
Accounts API | HelpLinks Object
- Custom help links and Default help links return is_featured, is_new, and feature_headline parameters
- Added Bulk Update Assignment Dates Endpoint
Assignments API | Edit an Assignment Endpoint
- Added clarification about +assignment key in assignment[assignment_overrides] parameter
- Added Query by Account Endpoint
2020-03-25
Additions
Assignments API | Create an Assignment Endpoint
- Added not_graded value in assignment[grading_type] parameter
- Added MediaTrack Object
- Added List Media Tracks for a Media Object Endpoint
- Added Update Media Tracks Endpoint
Changes
External Tools API | Create an External Tool Endpoint
- In resource_selection[enabled] parameter, changed description to clarify that if set to false, not_selectable must also be set to true in order to hide this tool from the selection UI in modules and assignments
- In not_selectable parameter, changed description to clarify that if set to true, and if resource_selection is set to false, the tool won’t show up in the external tool selection UI in modules and assignments
Removals
API Change Log and Breaking Changes
- The API Change Log and Breaking Changes page have been removed from the API Documentation. These pages are located in Canvas Community Canvas Platform Services.
2020-03-21
Additions
Courses API | Update a Course Endpoint
- Added syllabus_course_summary parameter
2020-03-11
Additions
External Tools API | Create an External Tool Endpoint
-
Added disabled and enabled values to course_navigation[default] parameter
Changes
External Tools API | Create an External Tool Endpoint
-
Changed boolean to string
2020-02-26
Additions
Assignments API | Assignment Object [REVERTED 2020-02-27]
- Added hidden_submissions_count parameter
SIS Import Format Documentation | Logins.csv
- Root Account row: Clarified that this field is required when identifying a user in a trusted account.
Changes
Feature Flags API | Feature Object
- Changed name property to feature
Removals
Assignments API | Assignment Object
- Deprecated muted parameter [Update 2020-02-27: a new parameter will be added in a future deploy]
- Removal date: 2020-06-03
2020-02-15
Additions
Developer Keys
- In the Canvas interface Administrative Notifications alert, added functionality for admins to receive a notification when tokens are manually created in the account or existing manually created tokens are regenerated in the account
Changes
Enrollments API
- This change is enabled in the beta environment to allow for testing until 2020-06-20, at which time the change will be deployed to the production environment.
- Changed bookmarks management to align with opaque pagination links, which helps minimize the pagination impact on the database.
- App developers relying on Canvas APIs need to update how their apps manage pagination using “rel” headers, rather than the numerical page number, as noted in Pagination - Canvas LMS REST API Documentation.
2020-02-12
Additions
- Added Reset Link Verifier Endpoint
External Tools LTI Variable Substitutions
- Added Canvas.course.endAt variable
2020-01-29
Additions
Groups API | List Group’s Users
- Added exclude_inactive parameter
Changes
Developer Keys | Canvas API Includes
- Changed documentation to note responses to requests made with a scoped access token only support this functionality when the Allow Include Parameters option is also enabled. When this option is disabled, a request is made with a scoped token Canvas will ignore include and includes parameters.
- The Allow Include Parameters option can be enabled when creating a new API Developer Key in the Canvas interface. Additional details about this feature can be found in the Canvas Release Notes (2020-02-15).
2020-01-18
Removals
Assignments API | Create an Assignment Endpoint | Assignment[muted] parameter
- Deprecated for enforcement of New Gradebook
Initial post date: 2019-07-13
2020-01-15
Additions
Assignment Groups API | List Assignment Groups Endpoint
- Added observed_users parameter
- Added API
