octoleo/restic
2
2
Fork 0
mirror of https://github.com/octoleo/restic.git synced 2024-11-10 23:31:09 +00:00
Code Issues Releases Wiki Activity
5957417b1f
restic/doc/075_scripting.rst

598 lines
30 KiB
ReStructuredText
Raw Normal View History

Add scripting section to docs
2018-04-04 14:43:20 +00:00
..
Normally, there are no heading levels assigned to certain characters as the structure is
determined from the succession of headings. However, this convention is used in Python’s
Style Guide for documenting which you may follow:
# with overline, for parts
* for chapters
= for sections
- for subsections
^ for subsubsections
" for paragraphs
#########################
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 initializing a repository multiple
doc: recommend `cat config` to check if a repository exists This will be much faster if a large number of snapshots exists.
2023-04-21 20:56:31 +00:00
times. The command ``cat config`` may be used for this purpose:
Add scripting section to docs
2018-04-04 14:43:20 +00:00
.. code-block:: console
doc: recommend `cat config` to check if a repository exists This will be much faster if a large number of snapshots exists.
2023-04-21 20:56:31 +00:00
$ restic -r /srv/restic-repo cat config
Fatal: unable to open config file: stat /srv/restic-repo/config: no such file or directory
Add scripting section to docs
2018-04-04 14:43:20 +00:00
Is there a repository at the following location?
Update docs
2018-04-28 14:19:16 +00:00
/srv/restic-repo
Add scripting section to docs
2018-04-04 14:43:20 +00:00
If a repository does not exist, restic will return a non-zero exit code
and print an error message. Note that restic will also return a non-zero
exit code if a different error is encountered (e.g.: incorrect password
doc: recommend `cat config` to check if a repository exists This will be much faster if a large number of snapshots exists.
2023-04-21 20:56:31 +00:00
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.
add json documentation
2020-05-16 04:40:09 +00:00
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
JSON output
***********
add json documentation
2020-05-16 04:40:09 +00:00
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
Restic outputs JSON data to ``stdout`` if requested with the ``--json`` flag.
add json documentation
2020-05-16 04:40:09 +00:00
The structure of that data varies depending on the circumstance. The
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
JSON output of most restic commands are documented here.
add json documentation
2020-05-16 04:40:09 +00:00
.. note::
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
Not all commands support JSON output. If a command does not support JSON output,
Documentation improvement
2020-11-26 07:54:53 +00:00
feel free to submit a pull request!
add json documentation
2020-05-16 04:40:09 +00:00
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
.. 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.
Output formats
--------------
Currently only the output on ``stdout`` is JSON formatted. Errors printed on ``stderr``
are still printed as plain text messages. The generated JSON output uses one of the
following two formats.
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
^^^^^^^^^^
add json documentation
2020-05-16 04:40:09 +00:00
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
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.
Documentation improvement
2020-11-26 07:54:53 +00:00
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
As an exception, the ``ls`` command uses the field ``struct_type`` instead.
backup
------
The ``backup`` command uses the JSON lines format with the following message types.
add json documentation
2020-05-16 04:40:09 +00:00
Status
^^^^^^
Documentation improvement
2020-11-26 07:54:53 +00:00
+----------------------+------------------------------------------------------------+
|``message_type`` | Always "status" |
+----------------------+------------------------------------------------------------+
|``seconds_elapsed`` | Time since backup started |
+----------------------+------------------------------------------------------------+
|``seconds_remaining`` | Estimated time remaining |
+----------------------+------------------------------------------------------------+
|``percent_done`` | Percentage of data backed up (bytes_done/total_bytes) |
+----------------------+------------------------------------------------------------+
|``total_files`` | Total number of files detected |
+----------------------+------------------------------------------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
|``files_done`` | Files completed (backed up to repo) |
Documentation improvement
2020-11-26 07:54:53 +00:00
+----------------------+------------------------------------------------------------+
|``total_bytes`` | Total number of bytes in backup set |
+----------------------+------------------------------------------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
|``bytes_done`` | Number of bytes completed (backed up to repo) |
Documentation improvement
2020-11-26 07:54:53 +00:00
+----------------------+------------------------------------------------------------+
|``error_count`` | Number of errors |
+----------------------+------------------------------------------------------------+
|``current_files`` | List of files currently being backed up |
+----------------------+------------------------------------------------------------+
add json documentation
2020-05-16 04:40:09 +00:00
Error
^^^^^
Documentation improvement
2020-11-26 07:54:53 +00:00
+----------------------+-------------------------------------------+
| ``message_type`` | Always "error" |
+----------------------+-------------------------------------------+
| ``error`` | Error message |
+----------------------+-------------------------------------------+
| ``during`` | What restic was trying to do |
+----------------------+-------------------------------------------+
| ``item`` | Usually, the path of the problematic file |
+----------------------+-------------------------------------------+
add json documentation
2020-05-16 04:40:09 +00:00
Verbose Status
^^^^^^^^^^^^^^
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
Verbose status provides details about the progress, including details about backed up files.
+----------------------+-----------------------------------------------------------+
| ``message_type`` | Always "verbose_status" |
+----------------------+-----------------------------------------------------------+
| ``action`` | Either "new", "unchanged", "modified" or "scan_finished" |
+----------------------+-----------------------------------------------------------+
| ``item`` | The item in question |
+----------------------+-----------------------------------------------------------+
| ``duration`` | How long it took, in seconds |
+----------------------+-----------------------------------------------------------+
| ``data_size`` | How big the item is |
+----------------------+-----------------------------------------------------------+
| ``metadata_size`` | How big the metadata is |
+----------------------+-----------------------------------------------------------+
| ``total_files`` | Total number of files |
+----------------------+-----------------------------------------------------------+
add json documentation
2020-05-16 04:40:09 +00:00
Summary
^^^^^^^
docs: remove trailing whitespace
2023-08-27 08:46:21 +00:00
Summary is the last output line in a successful backup.
Documentation improvement
2020-11-26 07:54:53 +00:00
add json documentation
2020-05-16 04:40:09 +00:00
+---------------------------+---------------------------------------------------------+
| ``message_type`` | Always "summary" |
+---------------------------+---------------------------------------------------------+
| ``files_new`` | Number of new files |
+---------------------------+---------------------------------------------------------+
| ``files_changed`` | Number of files that changed |
+---------------------------+---------------------------------------------------------+
| ``files_unmodified`` | Number of files that did not change |
+---------------------------+---------------------------------------------------------+
| ``dirs_new`` | Number of new directories |
+---------------------------+---------------------------------------------------------+
| ``dirs_changed`` | Number of directories that changed |
+---------------------------+---------------------------------------------------------+
| ``dirs_unmodified`` | Number of directories that did not change |
+---------------------------+---------------------------------------------------------+
| ``data_blobs`` | Number of data blobs |
+---------------------------+---------------------------------------------------------+
| ``tree_blobs`` | Number of tree blobs |
+---------------------------+---------------------------------------------------------+
| ``data_added`` | Amount of data added, in bytes |
+---------------------------+---------------------------------------------------------+
| ``total_files_processed`` | Total number of files processed |
+---------------------------+---------------------------------------------------------+
| ``total_bytes_processed`` | Total number of bytes processed |
+---------------------------+---------------------------------------------------------+
| ``total_duration`` | Total time it took for the operation to complete |
+---------------------------+---------------------------------------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
| ``snapshot_id`` | ID of the new snapshot |
add json documentation
2020-05-16 04:40:09 +00:00
+---------------------------+---------------------------------------------------------+
cat
---
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
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.
diff
----
The ``diff`` command uses the JSON lines format with the following message types.
change
^^^^^^
+------------------+--------------------------------------------------------------+
| ``message_type`` | Always "change" |
+------------------+--------------------------------------------------------------+
| ``path`` | Path that has changed |
+------------------+--------------------------------------------------------------+
| ``modifier`` | Type of change, a concatenation of the following characters: |
| | "+" = added, "-" = removed, "T" = entry type changed, |
Add bitrot detection to "diff" command This introduces a new modifier to the output of the diff command. It appears whenever two files being compared only differ in their content but not in their metadata. As far as we know, under normal circumstances, this should only ever happen if some kind of bitrot has happened in the source file. The prerequisite for this detection to work is that the right-side snapshot of the comparison has been created with "backup --force".
2023-10-20 18:15:53 +00:00
| | "M" = file content changed, "U" = metadata changed, |
| | "?" = bitrot detected |
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
+------------------+--------------------------------------------------------------+
statistics
^^^^^^^^^^
+---------------------+----------------------------+
| ``message_type`` | Always "statistics" |
+---------------------+----------------------------+
| ``source_snapshot`` | ID of first snapshot |
+---------------------+----------------------------+
| ``target_snapshot`` | ID of second snapshot |
+---------------------+----------------------------+
| ``changed_files`` | Number of changed files |
+---------------------+----------------------------+
| ``added`` | DiffStat object, see below |
+---------------------+----------------------------+
| ``removed`` | DiffStat object, see below |
+---------------------+----------------------------+
DiffStat object
+----------------+-------------------------------------------+
| ``files`` | Number of changed files |
+----------------+-------------------------------------------+
| ``dirs`` | Number of changed directories |
+----------------+-------------------------------------------+
| ``others`` | Number of changed other directory entries |
+----------------+-------------------------------------------+
| ``data_blobs`` | Number of data blobs |
+----------------+-------------------------------------------+
| ``tree_blobs`` | Number of tree blobs |
+----------------+-------------------------------------------+
| ``bytes`` | Number of bytes |
+----------------+-------------------------------------------+
add json documentation
2020-05-16 04:40:09 +00:00
find
----
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
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.
add json documentation
2020-05-16 04:40:09 +00:00
Documentation improvement
2020-11-26 07:54:53 +00:00
+-----------------+----------------------------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
| ``hits`` | Number of matches in the snapshot |
Documentation improvement
2020-11-26 07:54:53 +00:00
+-----------------+----------------------------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
| ``snapshot`` | ID of the snapshot |
Documentation improvement
2020-11-26 07:54:53 +00:00
+-----------------+----------------------------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
| ``matches`` | Array of Match objects detailing a match |
Documentation improvement
2020-11-26 07:54:53 +00:00
+-----------------+----------------------------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
Match object
Documentation improvement
2020-11-26 07:54:53 +00:00
+-----------------+----------------------------------------------+
| ``path`` | Object path |
+-----------------+----------------------------------------------+
| ``permissions`` | UNIX permissions |
+-----------------+----------------------------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
| ``type`` | Object type e.g. file, dir, etc... |
Documentation improvement
2020-11-26 07:54:53 +00:00
+-----------------+----------------------------------------------+
| ``atime`` | Access time |
+-----------------+----------------------------------------------+
| ``mtime`` | Modification time |
+-----------------+----------------------------------------------+
| ``ctime`` | Change time |
+-----------------+----------------------------------------------+
| ``name`` | Object name |
+-----------------+----------------------------------------------+
| ``user`` | Name of owner |
+-----------------+----------------------------------------------+
| ``group`` | Name of group |
+-----------------+----------------------------------------------+
Include inode in JSON output for find and ls This introduces the inode attribute to the JSON output emitted for nodes in `ls` and matches in `find`. There doesn't seem to be any discernible reason to omit the inode and it can be useful in scripting scenarios.
2023-10-11 18:35:43 +00:00
| ``inode`` | Inode number |
+-----------------+----------------------------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``mode`` | UNIX file mode, shorthand of ``permissions`` |
+-----------------+----------------------------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
| ``device_id`` | OS specific device identifier |
doc tweaks
2020-11-26 08:21:08 +00:00
+-----------------+----------------------------------------------+
| ``links`` | Number of hardlinks |
+-----------------+----------------------------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``uid`` | ID of owner |
+-----------------+----------------------------------------------+
| ``gid`` | ID of group |
+-----------------+----------------------------------------------+
| ``size`` | Size of object in bytes |
+-----------------+----------------------------------------------+
add json documentation
2020-05-16 04:40:09 +00:00
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
Blob object
+-----------------+--------------------------------------------+
| ``object_type`` | Either "blob" or "tree" |
+-----------------+--------------------------------------------+
| ``id`` | ID of found blob |
+-----------------+--------------------------------------------+
| ``path`` | Path in snapshot |
+-----------------+--------------------------------------------+
| ``parent_tree`` | Parent tree blob, only set for type "blob" |
+-----------------+--------------------------------------------+
| ``snapshot`` | Snapshot ID |
+-----------------+--------------------------------------------+
| ``time`` | Snapshot timestamp |
+-----------------+--------------------------------------------+
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 |
+-------------+-----------------------------------------------------------+
| ``host`` | Host identifying the snapshot group |
+-------------+-----------------------------------------------------------+
| ``paths`` | Paths identifying the snapshot group |
+-------------+-----------------------------------------------------------+
| ``keep`` | Array of Snapshot objects that are kept |
+-------------+-----------------------------------------------------------+
| ``remove`` | Array of Snapshot objects that were removed |
+-------------+-----------------------------------------------------------+
| ``reasons`` | Array of Reason objects describing why a snapshot is kept |
+-------------+-----------------------------------------------------------+
Snapshot object
doc: add program_version field of snapshot JSON output
2023-07-08 21:29:46 +00:00
+---------------------+--------------------------------------------------+
| ``time`` | Timestamp of when the backup was started |
+---------------------+--------------------------------------------------+
| ``parent`` | ID of the parent snapshot |
+---------------------+--------------------------------------------------+
| ``tree`` | ID of the root tree blob |
+---------------------+--------------------------------------------------+
| ``paths`` | List of paths included in the backup |
+---------------------+--------------------------------------------------+
| ``hostname`` | Hostname of the backed up machine |
+---------------------+--------------------------------------------------+
| ``username`` | Username the backup command was run as |
+---------------------+--------------------------------------------------+
| ``uid`` | ID of owner |
+---------------------+--------------------------------------------------+
| ``gid`` | ID of group |
+---------------------+--------------------------------------------------+
| ``excludes`` | List of paths and globs excluded from the backup |
+---------------------+--------------------------------------------------+
| ``tags`` | List of tags for the snapshot in question |
+---------------------+--------------------------------------------------+
| ``program_version`` | restic version used to create snapshot |
+---------------------+--------------------------------------------------+
| ``id`` | Snapshot ID |
+---------------------+--------------------------------------------------+
| ``short_id`` | Snapshot ID, short form |
+---------------------+--------------------------------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
Reason object
+----------------+---------------------------------------------------------+
| ``snapshot`` | Snapshot object, without ``id`` and ``short_id`` fields |
+----------------+---------------------------------------------------------+
| ``matches`` | Array containing descriptions of the matching criteria |
+----------------+---------------------------------------------------------+
| ``counters`` | Object containing counters used by the policies |
+----------------+---------------------------------------------------------+
init
----
The ``init`` command uses the JSON lines format, but only outputs a single message.
+------------------+--------------------------------+
| ``message_type`` | Always "initialized" |
+------------------+--------------------------------+
| ``id`` | ID of the created repository |
+------------------+--------------------------------+
| ``repository`` | URL of the repository |
+------------------+--------------------------------+
add json documentation
2020-05-16 04:40:09 +00:00
key list
--------
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
The ``key list`` command returns an array of objects with the following structure.
Documentation improvement
2020-11-26 07:54:53 +00:00
add json documentation
2020-05-16 04:40:09 +00:00
+--------------+------------------------------------+
| ``current`` | Is currently used key? |
+--------------+------------------------------------+
| ``id`` | Unique key ID |
+--------------+------------------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``userName`` | User who created it |
add json documentation
2020-05-16 04:40:09 +00:00
+--------------+------------------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``hostName`` | Name of machine it was created on |
add json documentation
2020-05-16 04:40:09 +00:00
+--------------+------------------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``created`` | Timestamp when it was created |
add json documentation
2020-05-16 04:40:09 +00:00
+--------------+------------------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
describe ls command in docs
2024-01-21 16:09:54 +00:00
.. _ls json:
add json documentation
2020-05-16 04:40:09 +00:00
ls
--
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
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.
Documentation improvement
2020-11-26 07:54:53 +00:00
add json documentation
2020-05-16 04:40:09 +00:00
snapshot
^^^^^^^^
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
+----------------+--------------------------------------------------+
| ``struct_type``| Always "snapshot" |
+----------------+--------------------------------------------------+
| ``time`` | Timestamp of when the backup was started |
+----------------+--------------------------------------------------+
| ``parent`` | ID of the parent snapshot |
+----------------+--------------------------------------------------+
| ``tree`` | ID of the root tree blob |
+----------------+--------------------------------------------------+
| ``paths`` | List of paths included in the backup |
+----------------+--------------------------------------------------+
| ``hostname`` | Hostname of the backed up machine |
+----------------+--------------------------------------------------+
| ``username`` | Username the backup command was run as |
+----------------+--------------------------------------------------+
| ``uid`` | ID of owner |
+----------------+--------------------------------------------------+
| ``gid`` | ID of group |
+----------------+--------------------------------------------------+
| ``excludes`` | List of paths and globs excluded from the backup |
+----------------+--------------------------------------------------+
| ``tags`` | List of tags for the snapshot in question |
+----------------+--------------------------------------------------+
| ``id`` | Snapshot ID |
+----------------+--------------------------------------------------+
| ``short_id`` | Snapshot ID, short form |
+----------------+--------------------------------------------------+
add json documentation
2020-05-16 04:40:09 +00:00
node
^^^^
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
+-----------------+--------------------------+
| ``struct_type`` | Always "node" |
add json documentation
2020-05-16 04:40:09 +00:00
+-----------------+--------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``name`` | Node name |
add json documentation
2020-05-16 04:40:09 +00:00
+-----------------+--------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``type`` | Node type |
add json documentation
2020-05-16 04:40:09 +00:00
+-----------------+--------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``path`` | Node path |
add json documentation
2020-05-16 04:40:09 +00:00
+-----------------+--------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``uid`` | UID of node |
add json documentation
2020-05-16 04:40:09 +00:00
+-----------------+--------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``gid`` | GID of node |
add json documentation
2020-05-16 04:40:09 +00:00
+-----------------+--------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``size`` | Size in bytes |
add json documentation
2020-05-16 04:40:09 +00:00
+-----------------+--------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``mode`` | Node mode |
add json documentation
2020-05-16 04:40:09 +00:00
+-----------------+--------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``atime`` | Node access time |
add json documentation
2020-05-16 04:40:09 +00:00
+-----------------+--------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``mtime`` | Node modification time |
add json documentation
2020-05-16 04:40:09 +00:00
+-----------------+--------------------------+
Documentation improvement
2020-11-26 07:54:53 +00:00
| ``ctime`` | Node creation time |
add json documentation
2020-05-16 04:40:09 +00:00
+-----------------+--------------------------+
Include inode in JSON output for find and ls This introduces the inode attribute to the JSON output emitted for nodes in `ls` and matches in `find`. There doesn't seem to be any discernible reason to omit the inode and it can be useful in scripting scenarios.
2023-10-11 18:35:43 +00:00
| ``inode`` | Inode number of node |
+-----------------+--------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
doc: describe JSON output of restore command
2023-06-17 19:47:17 +00:00
restore
-------
The ``restore`` command uses the JSON lines format with the following message types.
Status
^^^^^^
+----------------------+------------------------------------------------------------+
|``message_type`` | Always "status" |
+----------------------+------------------------------------------------------------+
|``seconds_elapsed`` | Time since restore started |
+----------------------+------------------------------------------------------------+
docs: add missing whitespace to avoid malformed table warning
2023-08-27 08:45:56 +00:00
|``percent_done`` | Percentage of data restored (bytes_restored/total_bytes) |
doc: describe JSON output of restore command
2023-06-17 19:47:17 +00:00
+----------------------+------------------------------------------------------------+
|``total_files`` | Total number of files detected |
+----------------------+------------------------------------------------------------+
|``files_restored`` | Files restored |
+----------------------+------------------------------------------------------------+
|``total_bytes`` | Total number of bytes in restore set |
+----------------------+------------------------------------------------------------+
|``bytes_restored`` | Number of bytes restored |
+----------------------+------------------------------------------------------------+
Summary
^^^^^^^
+----------------------+------------------------------------------------------------+
|``message_type`` | Always "summary" |
+----------------------+------------------------------------------------------------+
|``seconds_elapsed`` | Time since restore started |
+----------------------+------------------------------------------------------------+
|``total_files`` | Total number of files detected |
+----------------------+------------------------------------------------------------+
|``files_restored`` | Files restored |
+----------------------+------------------------------------------------------------+
|``total_bytes`` | Total number of bytes in restore set |
+----------------------+------------------------------------------------------------+
|``bytes_restored`` | Number of bytes restored |
+----------------------+------------------------------------------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
snapshots
---------
The snapshots command returns a single JSON object, an array with objects of the structure outlined below.
doc: add program_version field of snapshot JSON output
2023-07-08 21:29:46 +00:00
+---------------------+--------------------------------------------------+
| ``time`` | Timestamp of when the backup was started |
+---------------------+--------------------------------------------------+
| ``parent`` | ID of the parent snapshot |
+---------------------+--------------------------------------------------+
| ``tree`` | ID of the root tree blob |
+---------------------+--------------------------------------------------+
| ``paths`` | List of paths included in the backup |
+---------------------+--------------------------------------------------+
| ``hostname`` | Hostname of the backed up machine |
+---------------------+--------------------------------------------------+
| ``username`` | Username the backup command was run as |
+---------------------+--------------------------------------------------+
| ``uid`` | ID of owner |
+---------------------+--------------------------------------------------+
| ``gid`` | ID of group |
+---------------------+--------------------------------------------------+
| ``excludes`` | List of paths and globs excluded from the backup |
+---------------------+--------------------------------------------------+
| ``tags`` | List of tags for the snapshot in question |
+---------------------+--------------------------------------------------+
| ``program_version`` | restic version used to create snapshot |
+---------------------+--------------------------------------------------+
| ``id`` | Snapshot ID |
+---------------------+--------------------------------------------------+
| ``short_id`` | Snapshot ID, short form |
+---------------------+--------------------------------------------------+
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
add json documentation
2020-05-16 04:40:09 +00:00
stats
-----
docs(scripting): correct stats output comment to be about the correct command not about the snapshots command
2023-12-18 22:04:46 +00:00
The stats command returns a single JSON object.
doc: Expand JSON documentation
2023-06-08 22:46:55 +00:00
+------------------------------+-----------------------------------------------------+
| ``total_size`` | Repository size in bytes |
+------------------------------+-----------------------------------------------------+
| ``total_file_count`` | Number of files backed up in the repository |
+------------------------------+-----------------------------------------------------+
| ``total_blob_count`` | Number of blobs in the repository |
+------------------------------+-----------------------------------------------------+
| ``snapshots_count`` | Number of processed snapshots |
+------------------------------+-----------------------------------------------------+
| ``total_uncompressed_size`` | Repository size in bytes if blobs were uncompressed |
+------------------------------+-----------------------------------------------------+
| ``compression_ratio`` | Factor by which the already compressed data |
| | has shrunk due to compression |
+------------------------------+-----------------------------------------------------+
| ``compression_progress`` | Percentage of already compressed data |
+------------------------------+-----------------------------------------------------+
| ``compression_space_saving`` | Overall space saving due to compression |
+------------------------------+-----------------------------------------------------+
Add version command output to JSON format documentation
2023-11-01 21:13:57 +00:00
version
-------
The version command returns a single JSON object.
+----------------+--------------------+
| ``version`` | restic version |
+----------------+--------------------+
| ``go_version`` | Go compile version |
+----------------+--------------------+
Split `go_target` into `go_os` and `go_arch`
2023-11-01 21:43:38 +00:00
| ``go_os`` | Go OS |
+----------------+--------------------+
| ``go_arch`` | Go architecture |
Add version command output to JSON format documentation
2023-11-01 21:13:57 +00:00
+----------------+--------------------+
Copy Permalink