create_backup
Create a RouterOS system backup file that captures the device's full configuration to binary storage. Preview the target file first, then confirm to save without overwriting existing backups.
Instructions
Create a RouterOS system backup file (/system/backup/save name=<name>) - captures the device's full configuration into one
binary .backup file on its own storage. Use list_backups
afterward to confirm it landed and see its real size/creation-time.
password, if given, is RouterOS's own backup-FILE encryption
option (unrelated to any device/API credential) - forwarded to the
device, but NEVER included in the returned preview, and never
journaled. See guard.create_backup's docstring for how that
redaction is enforced.
WRITE tool, guarded: blocked entirely unless the server is running
with MIKROTIK_ALLOW_WRITE=true. Call with confirm=False (the
default) to get a preview of the file that would be created without
changing anything; call again with confirm=True to actually create
it. Errors clearly (without creating anything) if a .backup file
matching name already exists on the device - it never silently
overwrites one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| confirm | No | ||
| password | No | ||
| device_name | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||