2022 API Change Log Archive
The Change Log Archive page displays previous API changes from 2022 noted in the API Change Log. The heading date indicates the date that the API code was made available in the production environment.
[2021-08-17 Update]
Please note upcoming changes to Canvas APIs: From the Engineering Deck: Instructure & GraphQL
2022-12-20
Addition
Rest API and Extensions Documentation
Allow lti_context_id in Group API calls
- LTI tools with additional API access can query the API using a group's LTI ID without first determining the group’s Canvas ID.
- Note: This does not automatically change or update any tools, but enables tool developers to better support group functionality.
2023-01-23
Changes
- Line item updates made to assignments in a concluded course using the Assignment and Grading Service API return a 422 error with an explanation of the problem. Previously, a 404 error with no description was returned.
- Note: This update changes how third-party tools plug into and receive information from Canvas. Additionally, third-party tools are not automatically updated to take advantage of new features and capabilities offered.
Available in Beta starting: 2022-11-19
2022-11-19
Additions
Account Calendars
- Added API
2022-11-09
Additions
POST login/oauth2/token
- A new parameter, canvas_region, has been added to the OAuth token response (OAuth 2, section 4.1.3) that shows the AWS region (e.g., us-east-1) in which the institution that issued the token resides. Existing OAuth implementations can ignore this field.
2022-10-26
Changes
- This update affects LTI 1.3 tools using the Deep Linking specifications. The update changes the format of the deep_link_return_url. The existing query parameters on the URL wrap into a JWT for data consistency. Tools do not have to make any changes to respect this new url format, and should continue to redirect to the deep_link_return_url without modifying it in any way. No deep linking features have been changed.
- Note: This update changes how third-party tools plug into and receive information from Canvas. Additionally, third-party tools are not automatically updated to take advantage of new features and capabilities offered.
2022-10-23
Changes
- When an Assignment and Grades Scores API request includes content_items in the Canvas extension with a file upload url that times out or takes longer than 30 seconds to respond, the request will fail with a 504 status code and include a message that makes it clear that the file url timed out.
- When an Assignment and Grades Scores API request includes content_items in the canvas extension and provides a file upload url for a content item that fails or times out, the rest of the request body will not be processed so that the request can be repeated without concern for causing inaccurate data. If the file upload URL is continuously failing and the file is hosted by a 3rd party, it is recommended that tools consider waiting to retry the Scores requests to avoid constant failures.
- Assignment and Grades Scores API requests that include submitted_at in the canvas extension will use that parameter for the date of homework submission, regardless of the presence or absence of content_items.
Available in Beta starting: 2022-07-06
2022-08-03
Changes
Honor SIS Stickiness
-
override_sis_stickinesshas been added to the following endpoints to create feature parity with SIS Imports:- Edit a User
- Edit a User Login
- Edit a Section
- Update a Course
- Update an Enrollment Term
- Update an Account
- Edit a Group
- Crosslist a Section
- De-Crosslist a Section
-
Description:
- Default is true. If false, any fields containing "sticky" changes will not be updated. See SIS CSV Format documentation for information on which fields can have SIS stickiness.
Additions
REST API and Extensions Documentation
- Added LTI 1.3 support for tag prioritizeNonToolGrade:
- Given the LTI 1.3 tool and a grade already present for a given assignment in Canvas, when the tool passes the tag prioritizeNonToolGrade to AGS then the gradebook score is not changed.
- Given LTI 1.3 tool and no grade is present for a given assignment in Canvas, when the tool passes the tag prioritizeNonToolGrade to AGS then the gradebook score is updated with the value sent by the tool.
2022-07-06
Changes
- In the Users API, when searching the original lti_user_id of a merged user, the new lti_user_id will display in API calls and no longer return an error message.
Additions
SIS Import Format Documentation
User.csv
- Added home_account boolean field in SIS import user row.
- When set to true in an auto-merge consortium, any existing users with a matching integration_id are moved and associated data (pseudonyms, enrollments, submissions, files) are merged to the account where the SIS import is being performed.
2022-06-22
Changes
- In the Edit a User API, Admins can change the state of a user’s avatar.
2022-06-13
Removals
Authentication
- An unauthorized response from the JSON API will return a 403 (Forbidden) instead of a 401 code, to be more in line with HTTP standards. Additionally, localization of the “status” field in unauthenticated or unauthorized JSON errors is deprecated; the status will always be given in English.
2022-06-08
Removals- Delayed until 2022-06-13
Authentication
- An unauthorized response from the JSON API will return a 403 (Forbidden) instead of a 401 code, to be more in line with HTTP standards. Additionally, localization of the “status” field in unauthenticated or unauthorized JSON errors is deprecated; the status will always be given in English.
Changes
- In the Edit an assignment API, changes to the plagiarism platform with API are disabled after students submit.
Additions
The Names and Role Provisioning Services LTI 1.3 endpoints can now be configured to return the below variables:
- Canvas.user.loginId
- Canvas.user.sisIntegrationId
- Canvas.course.sectionIds
- Canvas.group.contextIds
- com.instructure.User.sectionNames
2022-05-25
Removals- Delayed as of 2022-05-31
Authentication
- An unauthorized response from the JSON API will return a 403 (Forbidden) instead of a 401 code, to be more in line with HTTP standards. Additionally, localization of the “status” field in unauthenticated or unauthorized JSON errors is deprecated; the status will always be given in English.
2022-05-11
Changes
- When an LTI user ID is merged into another LTI user ID, the API call uses the original LTI user ID when launching an LTI.
- In the Edit an assignment API, changes to the plagiarism platform with API are disabled after students submit. [Feature Delayed]
2022-03-16
Additions
Outcome Data Format
- Added friendly_description field name
2022-02-16
Additions
Added the following supported substitutions:
- ResourceLink.id
- ResourceLink.description
- ResourceLink.title
- ResourceLink.available.startDateTime
- ResourceLink.available.endDateTime
- ResourceLink.submission.endDateTime
Removals
Authentication
- An unauthorized response from the JSON API will return a 403 (Forbidden) instead of a 401 code, to be more in line with HTTP standards. Additionally, localization of the “status” field in unauthenticated or unauthorized JSON errors is deprecated; the status will always be given in English.
- Deprecation date: 2022-05-25
View 2021 Canvas API Change Log Archive
Subscribe to this document for content updates. To learn how, see Canvas Change Log FAQ
