# Scripting

This is a list of how certain tasks may be accomplished when you use restic via scripts.

## Check if a repository is already initialized

You may find a need to check if a repository is already initialized, perhaps to prevent your script from trying to initialize a repository multiple times (the `init` command contains a check to prevent overwriting existing repositories). The command `cat config` may be used for this purpose:

    $ restic -r /srv/restic-repo cat config
    Fatal: repository does not exist: unable to open config file: stat /srv/restic-repo/config: no such file or directory
    Is there a repository at the following location?
    /srv/restic-repo

If a repository does not exist, restic (since 0.17.0) will return exit code `10` and print a corresponding error message. Older versions return exit code `1`. Note that restic will also return exit code `1` if a different error is encountered (e.g.: incorrect password to `cat config`) and it may print a different error message. If there are no errors, restic will return a zero exit code and print the repository metadata.

## Exit codes

Restic commands return an exit code that signals whether the command was successful. The following table provides a general description, see the help of each command for a more specific description.

Warning

New exit codes will be added over time. If an unknown exit code is returned, then it MUST be treated as a command failure.

0 | Command was successful
1 | Command failed, see command help for more details
2 | Go runtime error
3 | `backup` command could not read some source data
10 | Repository does not exist (since restic 0.17.0)
11 | Failed to lock repository (since restic 0.17.0)
12 | Wrong password (since restic 0.17.1)
130 | Restic was interrupted using SIGINT or SIGSTOP

## JSON output

Restic outputs JSON data to `stdout` if requested with the `--json` flag. The structure of that data varies depending on the circumstance. The JSON output of most restic commands are documented here.

Note

Not all commands support JSON output. If a command does not support JSON output, feel free to submit a pull request!

Warning

We try to keep the JSON output backwards compatible. However, new message types or fields may be added at any time. Similarly, enum-like fields for which a fixed list of allowed values is documented may be extended at any time.

### Exit errors

Fatal errors will result in a final JSON message on `stderr` before the process exits. It will hold the error message and the exit code.

Note

Some errors cannot be caught and reported this way, such as Go runtime errors or command line parsing errors.

`message_type` | Always “exit_error” | string
`code` | Exit code (see above chart) | int
`message` | Error message | string

### Output formats

Commands print their main JSON output on `stdout`. The generated JSON output uses one of the following two formats.

Note

Not all messages and errors have been converted to JSON yet. Feel free to submit a pull request!

The datatypes specified in the following sections roughly correspond to the underlying Go types and are mapped to the JSON types as follows:

- `int32`, `int64`, `uint32`, `uint64` and `float64` are encoded as number.

- `bool` and `string` correspond to the respective types.

- `[]` in front of a type indicates that the field is an array of the respective type.

- `time.Time` is encoded as a string in RFC3339 format.

- `os.FileMode` is encoded as an `uint32`.

If a field contains a default value like `0` or `""`, it may be omitted from the JSON output.

#### Single JSON document

Several commands output a single JSON document that can be parsed in its entirety. Depending on the command, the output consists of either a single or multiple lines.

#### JSON lines

Several commands, in particular long running ones or those that generate a large output, use a format also known as JSON lines. It consists of a stream of new-line separated JSON messages. You can determine the nature of the message using the `message_type` field.

### backup

The `backup` command uses the JSON lines format with the following message types.

#### Status

`message_type` | Always “status” | string
`seconds_elapsed` | Time since backup started | uint64
`seconds_remaining` | Estimated time remaining | uint64
`percent_done` | Fraction of data backed up (bytes_done/total_bytes) | float64
`total_files` | Total number of files detected | uint64
`files_done` | Files completed (backed up to repo) | uint64
`total_bytes` | Total number of bytes in backup set | uint64
`bytes_done` | Number of bytes completed (backed up to repo) | uint64
`error_count` | Number of errors | uint64
`current_files` | List of files currently being backed up | []string

#### Error

These errors are printed on `stderr`.

`message_type` | Always “error” | string
`error.message` | Error message | string
`during` | What restic was trying to do | string
`item` | Usually, the path of the problematic file | string

#### Verbose Status

Verbose status provides details about the progress, including details about backed up files.

`message_type` | Always “verbose_status” | string
`action` | Either “new”, “unchanged”, “modified” or “scan_finished” | string
`item` | The item in question | string
`duration` | How long it took, in seconds | float64
`data_size` | How big the item is | uint64
`data_size_in_repo` | How big the item is in the repository | uint64
`metadata_size` | How big the metadata is | uint64
`metadata_size_in_repo` | How big the metadata is in the repository | uint64
`total_files` | Total number of files | uint64

#### Summary

Summary is the last output line in a successful backup.

`message_type` | Always “summary” | string
`dry_run` | Whether the backup was a dry run | bool
`files_new` | Number of new files | uint64
`files_changed` | Number of files that changed | uint64
`files_unmodified` | Number of files that did not change | uint64
`dirs_new` | Number of new directories | uint64
`dirs_changed` | Number of directories that changed | uint64
`dirs_unmodified` | Number of directories that did not change | uint64
`data_blobs` | Number of data blobs added | int64
`tree_blobs` | Number of tree blobs added | int64
`data_added` | Amount of (uncompressed) data added, in bytes | uint64
`data_added_packed` | Amount of data added (after compression), in bytes | uint64
`total_files_processed` | Total number of files processed | uint64
`total_bytes_processed` | Total number of bytes processed | uint64
`backup_start` | Time at which the backup was started | time.Time
`backup_end` | Time at which the backup was completed | time.Time
`total_duration` | Total time it took for the operation to complete | float64
`snapshot_id` | ID of the new snapshot. Field is omitted if snapshot creation was skipped | string

### cat

The `cat` command returns data about various objects in the repository, which are stored in JSON form. Specifying `--json` or `--quiet` will suppress any non-JSON messages the command generates.

### check

The `check` command uses the JSON lines format with the following message types.

#### Status

`message_type` | Always “summary” | string
`num_errors` | Number of errors | int64
`broken_packs` | Run “restic repair packs ID…” and “restic repair snapshots –forget” to remove damaged files | []string
`suggest_repair_index` | Run “restic repair index” | bool
`suggest_prune` | Run “restic prune” | bool

#### Error

These errors are printed on `stderr`.

`message_type` | Always “error” | string
`message` | Error message. May change in arbitrary ways across restic versions. | string

### diff

The `diff` command uses the JSON lines format with the following message types.

#### change

`message_type` | Always “change” | string
`path` | Path that has changed | string
`modifier` | Type of change, a concatenation of the following characters: “+” = added, “-” = removed, “T” = entry type changed, “M” = file content changed, “U” = metadata changed, “?” = bitrot detected | string

#### statistics

`message_type` | Always “statistics” | string
`source_snapshot` | ID of first snapshot | string
`target_snapshot` | ID of second snapshot | string
`changed_files` | Number of changed files | int64
`added` | Added items | DiffStat object
`removed` | Removed items | DiffStat object

DiffStat object

`files` | Number of changed files | int64
`dirs` | Number of changed directories | int64
`others` | Number of changed other directory entries | int64
`data_blobs` | Number of data blobs | int64
`tree_blobs` | Number of tree blobs | int64
`bytes` | Number of bytes | uint64

### find

The `find` command outputs a single JSON document containing an array of JSON objects with matches for your search term. These matches are organized by snapshot.

If the `--blob` or `--tree` option is passed, then the output is an array of Blob objects.

`hits` | Number of matches in the snapshot | uint64
`snapshot` | ID of the snapshot | string
`matches` | Details of a match | [] Match object

Match object

`path` | Object path | string
`permissions` | UNIX permissions | string
`name` | Object name | string
`type` | Object type e.g. file, dir, etc… | string
`atime` | Access time | time.Time
`mtime` | Modification time | time.Time
`ctime` | Change time | time.Time
`user` | Name of owner | string
`group` | Name of group | string
`inode` | Inode number | uint64
`mode` | UNIX file mode, shorthand of `permissions` | os.FileMode
`device_id` | OS specific device identifier | uint64
`links` | Number of hardlinks | uint64
`link_target` | Target of a symlink | string
`uid` | ID of owner | uint32
`gid` | ID of group | uint32
`size` | Size of object in bytes | uint64

Blob objects

`object_type` | Either “blob” or “tree” | string
`id` | ID of found blob | string
`path` | Path in snapshot | string
`parent_tree` | Parent tree blob, only set for type “blob” | string
`snapshot` | Snapshot ID | string
`time` | Snapshot timestamp | time.Time

### forget

The `forget` command prints a single JSON document containing an array of ForgetGroups. If specific snapshot IDs are specified, then no output is generated.

The `prune` command does not yet support JSON such that `forget --prune` results in a mix of JSON and text output.

#### ForgetGroup

`tags` | Tags identifying the snapshot group | []string
`host` | Host identifying the snapshot group | string
`paths` | Paths identifying the snapshot group | []string
`keep` | Array of Snapshot that are kept | [] Snapshot object
`remove` | Array of Snapshot that were removed | [] Snapshot object
`reasons` | Array of KeepReason objects describing why a snapshot is kept | [] KeepReason object

Snapshot object

`time` | Timestamp of when the backup was started | time.Time
`parent` | ID of the parent snapshot | string
`tree` | ID of the root tree blob | string
`paths` | List of paths included in the backup | []string
`hostname` | Hostname of the backed up machine | string
`username` | Username the backup command was run as | string
`uid` | ID of owner | uint32
`gid` | ID of group | uint32
`excludes` | List of paths and globs excluded from the backup | []string
`tags` | List of tags for the snapshot in question | []string
`program_version` | restic version used to create snapshot | string
`summary` | Snapshot statistics | SnapshotSummary object
`id` | Snapshot ID | string
`short_id` | Snapshot ID, short form (deprecated) | string

KeepReason object

`snapshot` | Snapshot described by this object | Snapshot object
`matches` | Array containing descriptions of the matching criteria | []string

### init

The `init` command uses the JSON lines format, but only outputs a single message.

`message_type` | Always “initialized” | string
`id` | ID of the created repository | string
`repository` | URL of the repository | string

### key list

The `key list` command returns an array of objects with the following structure.

`current` | Is currently used key? | bool
`id` | Unique key ID | string
`userName` | User who created it | string
`hostName` | Name of machine it was created on | string
`created` | Timestamp when it was created | local time.Time

### ls

The `ls` command uses the JSON lines format with the following message types. As an exception, the `struct_type` field is used to determine the message type.

#### snapshot

`message_type` | Always “snapshot” | string
`struct_type` | Always “snapshot” (deprecated) | string
`time` | Timestamp of when the backup was started | time.Time
`parent` | ID of the parent snapshot | string
`tree` | ID of the root tree blob | string
`paths` | List of paths included in the backup | []string
`hostname` | Hostname of the backed up machine | string
`username` | Username the backup command was run as | string
`uid` | ID of owner | uint32
`gid` | ID of group | uint32
`excludes` | List of paths and globs excluded from the backup | []string
`tags` | List of tags for the snapshot in question | []string
`program_version` | restic version used to create snapshot | string
`summary` | Snapshot statistics | SnapshotSummary object
`id` | Snapshot ID | string
`short_id` | Snapshot ID, short form (deprecated) | string

#### node

`message_type` | Always “node” | string
`struct_type` | Always “node” (deprecated) | string
`name` | Node name | string
`type` | Node type | string
`path` | Node path | string
`uid` | UID of node | uint32
`gid` | GID of node | uint32
`size` | Size in bytes | uint64
`mode` | Node mode | os.FileMode
`permissions` | Node mode as string | string
`atime` | Node access time | time.Time
`mtime` | Node modification time | time.Time
`ctime` | Node creation time | time.Time
`inode` | Inode number of node | uint64

### restore

The `restore` command uses the JSON lines format with the following message types.

#### Status

`message_type` | Always “status” | string
`seconds_elapsed` | Time since restore started | uint64
`percent_done` | Percentage of data restored (bytes_restored/total_bytes) | float64
`total_files` | Total number of files detected | uint64
`files_restored` | Files restored | uint64
`files_skipped` | Files skipped due to overwrite setting | uint64
`files_deleted` | Files deleted | uint64
`total_bytes` | Total number of bytes in restore set | uint64
`bytes_restored` | Number of bytes restored | uint64
`bytes_skipped` | Total size of skipped files | uint64

#### Error

These errors are printed on `stderr`.

`message_type` | Always “error” | string
`error.message` | Error message | string
`during` | Always “restore” | string
`item` | Usually, the path of the problematic file | string

#### Verbose Status

Verbose status provides details about the progress, including details about restored files. Only printed if –verbose=2 is specified.

`message_type` | Always “verbose_status” | string
`action` | Either “restored”, “updated”, “unchanged” or “deleted” | string
`item` | The item in question | string
`size` | Size of the item in bytes | uint64

#### Summary

`message_type` | Always “summary” | string
`seconds_elapsed` | Time since restore started | uint64
`total_files` | Total number of files detected | uint64
`files_restored` | Files restored | uint64
`files_skipped` | Files skipped due to overwrite setting | uint64
`files_deleted` | Files deleted | uint64
`total_bytes` | Total number of bytes in restore set | uint64
`bytes_restored` | Number of bytes restored | uint64
`bytes_skipped` | Total size of skipped files | uint64

### snapshots

The snapshots command returns a single JSON array with objects of the structure outlined below.

`time` | Timestamp of when the backup was started | time.Time
`parent` | ID of the parent snapshot | string
`tree` | ID of the root tree blob | string
`paths` | List of paths included in the backup | []string
`hostname` | Hostname of the backed up machine | string
`username` | Username the backup command was run as | string
`uid` | ID of owner | uint32
`gid` | ID of group | uint32
`excludes` | List of paths and globs excluded from the backup | []string
`tags` | List of tags for the snapshot in question | []string
`program_version` | restic version used to create snapshot | string
`summary` | Snapshot statistics | SnapshotSummary object
`id` | Snapshot ID | string
`short_id` | Snapshot ID, short form (deprecated) | string

SnapshotSummary object

The contained statistics reflect the information at the point64 in time when the snapshot was created.

`backup_start` | Time at which the backup was started | time.Time
`backup_end` | Time at which the backup was completed | time.Time
`files_new` | Number of new files | uint64
`files_changed` | Number of files that changed | uint64
`files_unmodified` | Number of files that did not change | uint64
`dirs_new` | Number of new directories | uint64
`dirs_changed` | Number of directories that changed | uint64
`dirs_unmodified` | Number of directories that did not change | uint64
`data_blobs` | Number of data blobs added | int64
`tree_blobs` | Number of tree blobs added | int64
`data_added` | Amount of (uncompressed) data added, in bytes | uint64
`data_added_packed` | Amount of data added (after compression), in bytes | uint64
`total_files_processed` | Total number of files processed | uint64
`total_bytes_processed` | Total number of bytes processed | uint64

### stats

The stats command returns a single JSON object.

`total_size` | Repository size in bytes | uint64
`total_file_count` | Number of files backed up in the repository | uint64
`total_blob_count` | Number of blobs in the repository | uint64
`snapshots_count` | Number of processed snapshots | uint64
`total_uncompressed_size` | Repository size in bytes if blobs were uncompressed | uint64
`compression_ratio` | Factor by which the already compressed data has shrunk due to compression | float64
`compression_progress` | Percentage of already compressed data | float64
`compression_space_saving` | Overall space saving due to compression | float64

### tag

The `tag` command uses the JSON lines format with the following message types.

#### Changed

`message_type` | Always “changed” | string
`old_snapshot_id` | ID of the snapshot before the change | string
`new_snapshot_id` | ID of the snapshot after the change | string

#### Summary

`message_type` | Always “summary” | string
`changed_snapshot_count` | Total number of changed snapshots | int64

### version

The version command returns a single JSON object.

`message_type` | Always “version” | string
`version` | restic version | string
`go_version` | Go compile version | string
`go_os` | Go OS | string
`go_arch` | Go architecture | string