{ "openapi": "3.0.1", "info": { "title": "n8n Workflow Backup, Restore & Security Audit", "description": "Offsite scheduled backups of all your n8n workflows, tags and variables. One-click restore to any instance (disaster recovery, migration, staging to prod) and a security + hygiene audit. Works with n8n Cloud and self-hosted. Free demo mode, pay per workflow.", "version": "1.0", "x-build-id": "umVaR3RBjf7wk39tg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/korado_labs~n8n-backup-restore/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-korado_labs-n8n-backup-restore", "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/korado_labs~n8n-backup-restore/runs": { "post": { "operationId": "runs-sync-korado_labs-n8n-backup-restore", "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/korado_labs~n8n-backup-restore/run-sync": { "post": { "operationId": "run-sync-korado_labs-n8n-backup-restore", "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", "properties": { "mode": { "title": "Mode", "enum": [ "backup", "restore", "audit" ], "type": "string", "description": "What to do: **Backup** exports all workflows + tags + variables from your instance. **Restore** imports a previous backup into an instance. **Audit** runs n8n's built-in security audit plus workflow hygiene checks.", "default": "backup" }, "instanceUrl": { "title": "n8n instance URL", "type": "string", "description": "Base URL of your n8n instance, e.g. `https://your-team.app.n8n.cloud` or `https://n8n.your-company.com`. **Leave empty to run a demo** on bundled sample workflows so you can see the output format without connecting anything." }, "apiKey": { "title": "n8n API key", "type": "string", "description": "n8n API key. Create it in your n8n instance under Settings → n8n API → Create API key. Stored encrypted by Apify; never written to the dataset or logs." }, "workflowNames": { "title": "Only these workflows (optional filter)", "type": "array", "description": "If set, only workflows whose name is in this list are backed up / restored / audited. Leave empty to process all workflows.", "items": { "type": "string" } }, "includeInactive": { "title": "Include inactive workflows", "type": "boolean", "description": "Backup and audit also cover workflows that are currently deactivated.", "default": true }, "includeWorkflowJson": { "title": "Include full workflow JSON in dataset rows", "type": "boolean", "description": "Each backup dataset row embeds the complete restorable workflow JSON (nodes, connections, settings). The full archive is always saved to the run's key-value store as `backup` either way.", "default": true }, "backupJson": { "title": "Backup JSON (restore mode)", "type": "string", "description": "Paste a backup here: either the `backup` archive produced by this Actor, an array of n8n workflow objects, or a single workflow exported from the n8n editor. Leave both this and Backup URL empty to automatically restore the latest backup made by this Actor on your account." }, "backupUrl": { "title": "Backup URL (restore mode)", "type": "string", "description": "URL of a backup to restore for point-in-time restores: use the signed 'Backup archive' link from the Output tab of a previous backup run. Leave empty (and Backup JSON empty) to automatically use the latest backup made by this Actor." }, "restoreConflict": { "title": "If a workflow with the same name already exists", "enum": [ "update", "skip", "duplicate" ], "type": "string", "description": "How to handle name collisions on the target instance during restore.", "default": "update" }, "activateAfterRestore": { "title": "Re-activate restored workflows", "type": "boolean", "description": "After restoring, activate workflows that were active in the backup. Off by default so a restore never silently starts triggers on the target instance.", "default": false }, "daysAbandonedWorkflow": { "title": "Days until a workflow counts as abandoned (audit mode)", "minimum": 1, "type": "integer", "description": "Audit flags workflows not updated in this many days as abandoned.", "default": 90 } } }, "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 } } } } } } } } } }