# Accessibility Course Scans

{% hint style="warning" %}
**Welcome to Our New API Docs!** This is the new home for all things API (previously at [Canvas LMS REST API Documentation](https://api.instructure.com)).
{% endhint %}

## Accessibility Course Scans API

### [Trigger accessibility course scan](#method.accessibility_course_scans.create) <a href="#method.accessibility_course_scans.create" id="method.accessibility_course_scans.create"></a>

[AccessibilityCourseScansController#create](https://github.com/instructure/canvas-lms/blob/master/app/controllers/accessibility_course_scans_controller.rb)

**`POST /api/v1/users/:user_id/educator_accessibility_course_scan`**

**Scope:** `url:POST|/api/v1/users/:user_id/educator_accessibility_course_scan`

Queues a background job that scans all a11y-enabled courses where the user has an active teacher or designer enrollment. Idempotent — if a scan is already queued or running, the existing Progress is returned.

Requires the educator\_dashboard feature flag on the root account and a11y\_checker\_account\_statistics on site admin.

**Request Parameters:**

| Parameter | Type              | Description                                                                                                     |
| --------- | ----------------- | --------------------------------------------------------------------------------------------------------------- |
| `user_id` | Required `string` | The ID of the user, or “self” for the current user. The requesting user may only trigger a scan for themselves. |

Returns a [Progress](/services/canvas/resources/progress.md#progress) object.

***

This documentation is generated directly from the Canvas LMS source code, available [on Github](https://github.com/instructure/canvas-lms).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developerdocs.instructure.com/services/canvas/resources/accessibility_course_scans.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.