How to import and export courses in Open edX?

Posted on by

Open edX allows course administrators to import and export courses for backup, migration, and sharing across platforms. Below is a step-by-step guide to managing course imports and exports.

1. Exporting a Course in Open edX

Exporting a course creates a .tar.gz archive containing all course content, settings, and structure.

Steps to Export a Course

  1. Log in to Open edX Studio.
  2. Open the course you want to export.
  3. Navigate to “Tools” → “Export Course” (top-right corner).
  4. The system generates a .tar.gz file.
  5. Click “Download Exported Course” to save it to your local computer.

🔹 What’s Included in the Export?
✅ Course structure (sections, subsections, units)
✅ Videos, text, and quizzes
✅ Grading settings and discussions
❌ Learner data (not included in the export)

2. Importing a Course in Open edX

You can import an exported course to another Open edX instance or restore a backup.

Steps to Import a Course

  1. Log in to Open edX Studio.
  2. Create a new course (or open an existing course).
  3. Navigate to “Tools” → “Import Course” (top-right corner).
  4. Click “Choose a file” and upload the .tar.gz course file.
  5. Click “Upload and Replace” to start the import.
  6. The system will process the course and display a success message.

🔹 What Happens During Import?
✅ Replaces existing course content (if applicable)
✅ Restores the course structure and assets
❌ Does NOT overwrite student enrollment or progress

3. Migrating Courses Between Open edX Platforms

If you’re moving courses between different Open edX versions, follow these steps:

  1. Export the course from the older platform.
  2. Check for compatibility issues (e.g., outdated XBlocks).
  3. Import into the new Open edX instance.
  4. Test the course to ensure all components work properly.

4. Bulk Importing Multiple Courses

If you need to import multiple courses:

  1. Place all .tar.gz course files in a designated import directory on the server.
  2. Use the Open edX management command: python manage.py cms import /path/to/courses/
  3. The system will process and add all courses.

5. Exporting and Importing Course Data via API

For automated backups and migrations, you can use Open edX APIs.

Export Course via API

curl -X GET "https://your-openedx-instance/api/courses/v1/export/course-v1:edX+DemoX+2023" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Import Course via API

curl -X POST "https://your-openedx-instance/api/courses/v1/import/" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-F "course_file=@course.tar.gz"

Conclusion

By using manual exports, bulk imports, and API automation, Open edX allows easy course backup, migration, and sharing across platforms. 🚀