.. 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 section covers environment variables and how certain tasks may be accomplished when you use restic via scripts.

.. _environment-variables:

Environment Variables

In addition to command-line options, restic supports passing various options in environment variables, which are listed below.

.. code-block:: console

RESTIC_REPOSITORY_FILE              Name of file containing the repository location (replaces --repository-file)
RESTIC_REPOSITORY                   Location of repository (replaces -r)
RESTIC_PASSWORD_FILE                Location of password file (replaces --password-file)
RESTIC_PASSWORD                     The actual password for the repository
RESTIC_PASSWORD_COMMAND             Command printing the password for the repository to stdout
RESTIC_KEY_HINT                     ID of key to try decrypting first, before other keys
RESTIC_CACERT                       Location(s) of certificate file(s), comma separated if multiple (replaces --cacert)
RESTIC_TLS_CLIENT_CERT              Location of TLS client certificate and private key (replaces --tls-client-cert)
RESTIC_CACHE_DIR                    Location of the cache directory
RESTIC_COMPRESSION                  Compression mode (only available for repository format version 2)
RESTIC_HOST                         Only consider snapshots for this host / Set the hostname for the snapshot manually (replaces --host)
RESTIC_PROGRESS_FPS                 Frames per second by which the progress bar is updated
RESTIC_PACK_SIZE                    Target size for pack files
RESTIC_READ_CONCURRENCY             Concurrency for file reads

TMPDIR                              Location for temporary files (except Windows)
TMP                                 Location for temporary files (only Windows)

AWS_ACCESS_KEY_ID                   Amazon S3 access key ID
AWS_SECRET_ACCESS_KEY               Amazon S3 secret access key
AWS_SESSION_TOKEN                   Amazon S3 temporary session token
AWS_DEFAULT_REGION                  Amazon S3 default region
AWS_PROFILE                         Amazon credentials profile (alternative to specifying key and region)
AWS_SHARED_CREDENTIALS_FILE         Location of the AWS CLI shared credentials file (default: ~/.aws/credentials)
RESTIC_AWS_ASSUME_ROLE_ARN          Amazon IAM Role ARN to assume using discovered credentials
RESTIC_AWS_ASSUME_ROLE_SESSION_NAME Session Name to use with the role assumption
RESTIC_AWS_ASSUME_ROLE_EXTERNAL_ID  External ID to use with the role assumption
RESTIC_AWS_ASSUME_ROLE_POLICY       Inline Amazion IAM session policy
RESTIC_AWS_ASSUME_ROLE_REGION       Region to use for IAM calls for the role assumption (default: us-east-1)
RESTIC_AWS_ASSUME_ROLE_STS_ENDPOINT URL to the STS endpoint (default is determined based on RESTIC_AWS_ASSUME_ROLE_REGION). You generally do not need to set this, advanced use only.

AZURE_ACCOUNT_NAME                  Account name for Azure
AZURE_ACCOUNT_KEY                   Account key for Azure
AZURE_ACCOUNT_SAS                   Shared access signatures (SAS) for Azure
AZURE_ENDPOINT_SUFFIX               Endpoint suffix for Azure Storage (default: core.windows.net)
AZURE_FORCE_CLI_CREDENTIAL          Force the use of Azure CLI credentials for authentication

B2_ACCOUNT_ID                       Account ID or applicationKeyId for Backblaze B2
B2_ACCOUNT_KEY                      Account Key or applicationKey for Backblaze B2

GOOGLE_PROJECT_ID                   Project ID for Google Cloud Storage
GOOGLE_APPLICATION_CREDENTIALS      Application Credentials for Google Cloud Storage (e.g. $HOME/.config/gs-secret-restic-key.json)

OS_AUTH_URL                         Auth URL for keystone authentication
OS_REGION_NAME                      Region name for keystone authentication
OS_USERNAME                         Username for keystone authentication
OS_USER_ID                          User ID for keystone v3 authentication
OS_PASSWORD                         Password for keystone authentication
OS_TENANT_ID                        Tenant ID for keystone v2 authentication
OS_TENANT_NAME                      Tenant name for keystone v2 authentication

OS_USER_DOMAIN_NAME                 User domain name for keystone authentication
OS_USER_DOMAIN_ID                   User domain ID for keystone v3 authentication
OS_PROJECT_NAME                     Project name for keystone authentication
OS_PROJECT_DOMAIN_NAME              Project domain name for keystone authentication
OS_PROJECT_DOMAIN_ID                Project domain ID for keystone v3 authentication
OS_TRUST_ID                         Trust ID for keystone v3 authentication

OS_APPLICATION_CREDENTIAL_ID        Application Credential ID (keystone v3)
OS_APPLICATION_CREDENTIAL_NAME      Application Credential Name (keystone v3)
OS_APPLICATION_CREDENTIAL_SECRET    Application Credential Secret (keystone v3)

OS_STORAGE_URL                      Storage URL for token authentication
OS_AUTH_TOKEN                       Auth token for token authentication

RCLONE_BWLIMIT                      rclone bandwidth limit

RESTIC_REST_USERNAME                Restic REST Server username
RESTIC_REST_PASSWORD                Restic REST Server password

ST_AUTH                             Auth URL for keystone v1 authentication
ST_USER                             Username for keystone v1 authentication
ST_KEY                              Password for keystone v1 authentication

See :ref:caching for the rules concerning cache locations when RESTIC_CACHE_DIR is not set.

The external programs that restic may execute include rclone (for rclone backends) and ssh (for the SFTP backend). These may respond to further environment variables and configuration files; see their respective manuals.

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:

.. code-block:: console

$ 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:

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:

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.

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 ^^^^^^

Error ^^^^^

These errors are printed on stderr.

Verbose Status ^^^^^^^^^^^^^^

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

Summary ^^^^^^^

Summary is the last output line in a successful backup.

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 ^^^^^^

statistics ^^^^^^^^^^

.. _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:

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, --tree or --pack option is passed, then the output is an array of Blob objects_.

.. _Match object:

Match object

.. _Blob objects:

Blob objects

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:

Snapshot object

.. _KeepReason object:

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.

key list

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

.. _ls json:

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 ^^^^^^^^

node ^^^^

restore

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

Status ^^^^^^

Error ^^^^^

These errors are printed on stderr.

Verbose Status ^^^^^^^^^^^^^^

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

Summary ^^^^^^^

snapshots

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

.. _SnapshotSummary object:

SnapshotSummary object

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

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 | float64 | | | has shrunk due to compression | | +------------------------------+-----------------------------------------------------+---------+ | 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 ^^^^^^^

Summary ^^^^^^^

+-----------------------+-----------------------------------+--------+ | message_type | Always "summary" | string | +-----------------------+-----------------------------------+--------+ | changed_snapshots | Total number of changed snapshots | int64 | +-----------------------+-----------------------------------+--------+

version

The version command returns a single JSON object.