cloud_backup.restore
====================

Restore files to the directory `destination_path` from the `snapshot_id` subfolder `subfolder` created by the cloud backup job `id`.

This method is a job.

.. raw:: html

    <div id="json-schema"> <span class="badge badge-dark value-type">Type: object</span><br/> <div class="accordion" id="accordionCall_parameters"> <div class="card"> <div class="card-header" id="headingCall_parameters"> <h2 class="mb-0"> <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters"> <div class="card-body pl-5"> <span class="badge badge-dark value-type">Type: array</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4> <h5>Parameter 1: id</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>id</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>ID of the cloud backup task</p> </span> </div> </div> <h5>Parameter 2: snapshot_id</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1"> <h4>snapshot_id</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>ID of the snapshot to restore</p> </span><span class="pattern-value" id="Call_parameters_items_i1_pattern">Must match regular expression: <code>^[^-]</code></span> </div> </div> <h5>Parameter 3: subfolder</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i2"> <h4>subfolder</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Path within the snapshot to restore</p> </span> </div> </div> <h5>Parameter 4: destination_path</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i3"> <h4>destination_path</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Local path to restore to</p> </span> </div> </div> <h5>Parameter 5: options</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i4"> <h4>options</h4><span class="badge badge-dark value-type">Type: object</span> <span class="badge badge-success default-value">Default: {"exclude": [], "include": []}</span><br/> <span class="description"><p>Additional restore options</p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i4_exclude"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i4_exclude"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i4_exclude" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i4_exclude" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i4_exclude')" type="button"><span class="property-name">exclude</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i4_exclude" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i4_exclude" id="Call_parameters_items_i4_exclude"> <div class="card-body pl-5"> <h4>Exclude</h4><span class="badge badge-dark value-type">Type: array of string</span> <span class="badge badge-success default-value">Default: []</span><br/> <span class="description"><p>Paths to exclude from a restore using <code>restic restore --exclude</code></p> </span> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i4_exclude_items"> <span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i4_include"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i4_include"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i4_include" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i4_include" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i4_include')" type="button"><span class="property-name">include</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i4_include" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i4_include" id="Call_parameters_items_i4_include"> <div class="card-body pl-5"> <h4>Include</h4><span class="badge badge-dark value-type">Type: array of string</span> <span class="badge badge-success default-value">Default: []</span><br/> <span class="description"><p>Paths to include in a restore using <code>restic restore --include</code></p> </span> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i4_include_items"> <span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value"> <div class="card"> <div class="card-header" id="headingReturn_value"> <h2 class="mb-0"> <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button> </h2> </div> <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value"> <div class="card-body pl-5"> <h4>Result</h4><span class="badge badge-dark value-type">Type: null</span><br/> </div> </div> </div> </div> </div><br><br>

*Required roles:* FILESYSTEM_DATA_WRITE

