Skip to main content

KnotLink protocol and integration

Connect external tools through KnotLink and distinguish parameterized requests, acceptance and final task completion.

FolderRewind 1.9 keeps KnotLink Server v3 and parameterized wire protocol v2. Current capability manifestVersion=3.0.0, specVersion=1.0 and Plugin API 3.9 evolve independently.

Format and encoding​

Requests start with cmd= and use strict semicolon-separated key/value fields. Percent-encode dynamic values per RFC3986; encode list items individually before joining with commas. Legacy space-separated commands are unsupported. Long operations need from/request_id.

cmd=BACKUP;config_id=demo;folder=World;comment=Before%20upgrade;from=panel;request_id=backup-001
status=ok;from=panel;request_id=backup-001;message=Queued

Discover before invoking​

Use cmd=PING, then cmd=GET_CAPABILITIES for percent-encoded JSON func_list. Check commands, plugin selectors, arguments and signals from the runtime list rather than guessing by plugin name.

Lifecycle and semantics​

status=ok may mean accepted, not completed. Correlate later signals using request_id and avoid duplicate destructive requests. Remote Restore defaults Clean; partial captures force Overwrite. Omitting file invokes active-branch Quick Restore, not the preceding timestamp.

Plugins​

API 3.9 integration declares commands/signals. Target resolution selects stable IDs and reuses Host operations. MineRewind offers current_save selectors for seven folder commands; an active, unambiguous world is required.

See the command reference, developer API and Minecraft integration.