Dify Backup Plugin

Author: leslie2046
Version: 0.0.1
Type: tool

🔄 One-click backup and export Dify application DSL configurations

---

✨ Features

• 📦 Batch Export Apps - Export all applications DSL in workspace
• 🎯 Single App Export - Export specific application DSL
• 🔀 Version Support - Draft / Published / All versions
• 🏷️ Type Filter - Workflow / Chat / Agent, etc.
• 📝 Batch Export Annotations - Export annotations for all apps as CSV

🚀 Quick Start

1. Install Plugin

Search for "Dify Backup" in Dify Plugin Marketplace and install, or upload the plugin package manually.

2. Configure Credentials

Parameter	Description	Example
Dify Instance URL	Dify instance base URL	https://cloud.dify.ai
Email	Account email	admin@example.com
Password	Account password	-

⚠️ URL should not include /console or /api suffix

3. Start Using

After configuration, you can invoke the export tools in workflows or conversations.

---

🛠️ Tools

Export All Apps

Batch export DSL configurations for all applications in the workspace.

Parameter	Type	Required	Description
app_mode	select	✅	App type: all / workflow / chat / agent-chat / completion
version_type	select	✅	Version: draft / published / all

Output Format: Streaming JSON, returns DSL for each app

{
  "id": "app-uuid",
  "name": "App Name",
  "mode": "workflow",
  "version": "draft",
  "filename": "AppName-draft.yml",
  "dsl": { ... }
}

Export Single App

Export DSL configuration for a specific application.

Parameter	Type	Required	Description
app_identifier	app-selector	✅	Select app from dropdown
version_type	select	✅	Version: draft / published / all

Export All Annotations

Batch export annotations (Q&A pairs) for all applications in the workspace.

• No parameters required - One-click export
• Smart filtering - Automatically skips apps with no annotations
• CSV format - Each app exports as {AppName}-annotations.csv

Output Format: Streaming JSON, returns CSV content for each app with annotations

{
  "name": "App Name",
  "filename": "AppName-annotations.csv",
  "content": "\"question\",\"answer\"\n\"Q1\",\"A1\"\n..."
}

---

💡 Use Cases

Scheduled Auto Backup

Create a scheduled workflow to automatically backup all apps:

┌─────────────┐    ┌──────────────────┐    ┌─────────────┐
│   Schedule  │───▶│ Export All Apps  │───▶│   Storage   │
│ (Daily 2AM) │    │                  │    │             │
└─────────────┘    └──────────────────┘    └─────────────┘

Version Archiving

Export current version as archive before publishing new version.

Environment Migration

1. Export all apps in dev environment (version_type=published)
2. Import in production environment

---

🔧 Technical Details

Item	Description
Timeout	60 seconds
Authentication	Email/password login
Output Format	Streaming JSON
File Naming	{AppName}-{VersionId}.yml

API Endpoints

Endpoint	Description
POST /console/api/login	Login authentication
GET /console/api/apps	List applications
GET /console/api/apps/{id}/export	Export DSL
GET /console/api/apps/{id}/annotations	Get annotations

---

❓ FAQ

Issue	Solution
Login Failed	Check email/password, verify URL is accessible
Request Timeout	Check network, export in batches
Empty Versions	Some app types don't support version management

🔒 Privacy Policy

This plugin does not store or share any user data. Credentials are only used for direct communication with your specified Dify instance.

See PRIVACY.md for details.

📄 License

Apache License 2.0

---

Made with ❤️ for Dify