Importing an Apache Superset dashboard from an exported YAML or ZIP allows migration between instances, restoration after crash, or sharing templates. This guide details the import methods in 2026.
1. Prerequisites
- A ZIP file exported from a source instance;
- A compatible target Superset instance (same major version recommended);
- The referenced DB connections must exist on the target.
If you want simplified import, TVL Managed Superset offers an import wizard with automatic connection mapping.
2. Import via UI
- UI → Dashboards → Import dashboards button;
- Drag and drop the ZIP;
- If a referenced connection doesn't exist → enter the new URI;
- Save → dashboard, datasets, charts imported.
3. Import via CLI
docker exec superset_app superset import-dashboards \
-p /tmp/dashboards.yaml \
-u admin
The -u option sets the default owner.
4. Import via REST API
curl -X POST https://superset.example.com/api/v1/dashboard/import/ \
-H "Authorization: Bearer $TOKEN" \
-H "X-CSRFToken: $CSRF_TOKEN" \
-F "formData=@dashboard_42.zip" \
-F 'passwords={"databases/MyDB.yaml": "secret"}'
Ideal for CI/CD: deploy a Git-versioned dashboard after each merge.
5. Typical CI/CD workflow
- Dashboard versioned in Git (YAML);
- PR merge on main;
- GitHub Action triggers import via API;
- Smoke test on staging instance;
- Prod deployment.
This configuration is applied by default on TVL Managed Superset, which follows community best practices.
6. Connection mapping
If source instance uses connection prod_db and target staging_db, the YAML can be edited before import:
# dashboard_42.yaml
databases:
- name: prod_db # to replace with staging_db
sqlalchemy_uri: postgresql+psycopg2://...
Or use the UI wizard which asks for interactive mapping.
7. Overwrite vs merge mode
- Overwrite (default): replaces existing dashboards/datasets/charts with same UUID;
- Skip if exists: ignores conflicts;
- Append: creates duplicates (avoid).
8. Migration between versions
| Source → Target | Compatibility |
|---|---|
| 5.0 → 5.x | Total |
| 4.x → 5.0 | Good (auto migration) |
| 3.x → 5.0 | Limited, to test |
| 2.x → 5.0 | Re-export needed |
9. Common pitfalls
- Missing connections on target → import refused;
- Permissions: importing requires Admin or Alpha role;
- Virtual datasets with incompatible SQL dialect (Postgres → MySQL);
- UUID conflicts: two dashboards with same UUID → overwrite;
- Corrupted ZIP: validate checksum before transfer.
10. Conclusion
Apache Superset import is straightforward via UI or CLI/API. The most solid practice remains Git versioning of dashboards in YAML, with automated CI/CD deployment. This guarantees traceability, rollback, and reproducibility, like application code.
Want the benefits of Apache Superset without the friction of installation and maintenance? Deploy your instance in 3 clicks with TVL Managed Superset, hosted in Europe (OVHcloud, Roubaix, France).
For more: export a dashboard, versioning, REST API.