{ "openapi": "3.0.1", "info": { "title": "Canvas LMS Export & Backup", "description": "Export and back up authorized Canvas LMS courses through the official API. Archive modules, pages, files, assignments, discussions, quizzes, enrollments, and submissions with secure tokens and an audit manifest.", "version": "0.2", "x-build-id": "Lj1yP6bdlrTgdm0Uv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plenteous_humidifier~canvas-complete-archive/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plenteous_humidifier-canvas-complete-archive", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/plenteous_humidifier~canvas-complete-archive/runs": { "post": { "operationId": "runs-sync-plenteous_humidifier-canvas-complete-archive", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/plenteous_humidifier~canvas-complete-archive/run-sync": { "post": { "operationId": "run-sync-plenteous_humidifier-canvas-complete-archive", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "canvasBaseUrl", "apiToken" ], "properties": { "canvasBaseUrl": { "title": "Canvas base URL", "pattern": "^https:\\/\\/[^\\s?#]+\\/?$", "type": "string", "description": "Your institution's HTTPS Canvas URL, for example https://school.instructure.com. Do not include /api/v1." }, "apiToken": { "title": "Canvas API token", "type": "string", "description": "A scoped Canvas access token. Apify stores this input encrypted." }, "courseIds": { "title": "Course IDs", "uniqueItems": true, "type": "array", "description": "Optional Canvas course IDs. Leave empty to archive visible courses up to the course limit.", "items": { "type": "string" }, "default": [] }, "includeConcludedCourses": { "title": "Include concluded courses", "type": "boolean", "description": "When course IDs are empty, include both active and completed courses.", "default": true }, "maxCourses": { "title": "Maximum courses", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Safety limit when selecting courses automatically.", "default": 10 }, "resources": { "title": "Resources to export", "minItems": 1, "uniqueItems": true, "type": "array", "description": "Course resources to collect. Enrollments and submissions contain personal data and require explicit acknowledgment.", "items": { "type": "string", "enum": [ "modules", "pages", "files", "assignments", "discussions", "announcements", "quizzes", "enrollments", "submissions" ], "enumTitles": [ "Modules", "Pages", "File metadata", "Assignments and rubrics", "Discussions", "Announcements", "Quizzes", "Enrollments (sensitive)", "Submissions and grades (sensitive)" ] }, "default": [ "modules", "pages", "files", "assignments", "discussions", "announcements", "quizzes" ] }, "submissionScope": { "title": "Submission scope", "enum": [ "self", "all" ], "type": "string", "description": "Export only the authenticated student's submissions or all visible submissions. The all option requires instructor/admin permissions.", "default": "self" }, "acknowledgeSensitiveData": { "title": "I am authorized to export personal data", "type": "boolean", "description": "Required when exporting enrollments or submissions. You are responsible for institutional approval and applicable privacy law.", "default": false }, "downloadFiles": { "title": "Download file bodies", "type": "boolean", "description": "Save authorized Canvas files to the run's private key-value store. Otherwise, only file metadata is exported.", "default": false }, "maxFileSizeMb": { "title": "Maximum file size", "minimum": 1, "maximum": 256, "type": "integer", "description": "Skip individual files larger than this limit.", "default": 50 }, "maxRecordsPerResource": { "title": "Maximum records per resource", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Per-course cap for each resource type.", "default": 5000 }, "requestConcurrency": { "title": "Request concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Number of resource groups fetched in parallel per course.", "default": 4 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 300, "type": "integer", "description": "Timeout for each Canvas API request.", "default": 60 }, "maxRequestRetries": { "title": "Maximum retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retry count for rate limits, server errors, and temporary network failures.", "default": 3 }, "failOnResourceError": { "title": "Stop on resource error", "type": "boolean", "description": "Stop the run when one resource is unavailable instead of recording the failure in the manifest.", "default": false }, "preserveUrlQueryParameters": { "title": "Preserve URL query parameters", "type": "boolean", "description": "Disabled by default so signed download parameters are not persisted in datasets.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }