Canvas

Canvas Sis Imports API

The Sis Imports API from Canvas — 6 operation(s) for sis imports.

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/accounts/{account_id}/sis_imports List SIS imports for an account · Get SIS import list #
Ask an LLM
“Which SIS imports have run on my root account?”
“Can I see only SIS imports created in a date range?”
Tell an agent
List SIS imports for account {account_id}.
Show SIS imports in account {account_id} created since {created_since}.
POST /v1/accounts/{account_id}/sis_imports Import SIS data into Canvas · Import SIS data #
Ask an LLM
“How do I upload a SIS CSV file to sync users and enrollments?”
“Can I run a SIS import in batch mode for one term?”
Tell an agent
Import SIS file {attachment} into account {account_id}.
Run a batch-mode SIS import of {attachment} into account {account_id} for term {batch_mode_term_id}.
GET /v1/accounts/{account_id}/sis_imports/importing Show SIS imports currently running · Get the current importing SIS import #
Ask an LLM
“Is a SIS import running on my account right now?”
“Which SIS imports are still processing?”
Tell an agent
Show the SIS imports currently processing in account {account_id}.
Check whether account {account_id} has an import in progress.
GET /v1/accounts/{account_id}/sis_imports/{id} Get a SIS import's status · Get SIS import status #
Ask an LLM
“Did my SIS import finish, and were there errors?”
“What's the progress of a particular SIS import?”
Tell an agent
Get the status of SIS import {id} in account {account_id}.
Show progress and errors for SIS import {id} on account {account_id}.
PUT /v1/accounts/{account_id}/sis_imports/{id}/restore_states Roll back states changed by a SIS import · Restore workflow_states of SIS imported items #
Ask an LLM
“Can I undo the deletions a bad SIS import made?”
“Is it possible to restore only the enrollments a SIS import concluded?”
Tell an agent
Restore the workflow states changed by SIS import {id} in account {account_id}.
Undelete only the items removed by SIS import {id} in account {account_id}, undelete only {undelete_only}.
PUT /v1/accounts/{account_id}/sis_imports/{id}/abort Abort a SIS import · Abort SIS import #
Ask an LLM
“How do I stop a SIS import that's still running?”
“How long before the next import starts after I abort one?”
Tell an agent destructive · confirm first
Abort SIS import {id} in account {account_id}.
Cancel the unfinished SIS import {id} on account {account_id}.
PUT /v1/accounts/{account_id}/sis_imports/abort_all_pending Abort all pending SIS imports · Abort all pending SIS imports #
Ask an LLM
“Can I cancel every queued SIS import at once?”
“What's the way to clear the SIS import backlog?”
Tell an agent destructive · confirm first
Abort all pending SIS imports in account {account_id}.
Cancel every queued SIS import on account {account_id}.

Documentation

📖
Documentation
https://canvas.instructure.com/doc/api/
📖
Authentication
https://canvas.instructure.com/doc/api/file.oauth.html
📖
APIReference
https://canvas.instructure.com/doc/api/
📖
RateLimits
https://artifacts.apis.io/canvas/rate-limits/canvas-rate-limits.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/canvas/openapi/canvas-sis-imports-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/instructure/canvas-lms

Other Resources

🔗
Pagination
https://canvas.instructure.com/doc/api/file.pagination.html
🔗
Swagger
https://canvas.instructure.com/doc/api/api-docs.json
🔗
OAuthScopes
https://artifacts.apis.io/canvas/scopes/canvas-scopes.yml
🔗
ErrorCatalog
https://artifacts.apis.io/canvas/errors/canvas-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/canvas/data-model/canvas-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/canvas:canvas-sis-imports-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

canvas-sis-imports-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Canvas LMS REST Sis Imports API
  version: v1
  summary: The complete Canvas LMS REST API, converted from the Swagger 1.2 documents Instructure publishes under https://canvas.instructure.com/doc/api/.
  description: The Canvas LMS REST API covers courses, assignments, quizzes, grades, users, enrollments, accounts, files, modules, rubrics, submissions, SIS imports, LTI, analytics and account administration.
  contact:
    name: Instructure Canvas
    url: https://canvas.instructure.com/doc/api/
  license:
    name: AGPL-3.0
    url: https://github.com/instructure/canvas-lms/blob/master/LICENSE
servers:
- url: https://canvas.instructure.com/api
  description: Instructure-hosted Canvas (canvas.instructure.com)
- url: https://{canvas_host}/api
  description: Any Canvas instance; Canvas is multi-tenant and self-hostable, so the host is the institution's Canvas domain.
  variables:
    canvas_host:
      default: canvas.instructure.com
      description: Your institution's Canvas hostname, e.g. school.instructure.com
security:
- bearerAuth: []
- oauth2: []
tags:


# --- truncated at 32 KB (38 KB total) ---
# Full source: https://artifacts.apis.io/canvas/openapi/canvas-sis-imports-api-openapi.yml