config.save
===========

Create a tar file of security-sensitive information.

If none of these options are set, the tar file is not generated and the database file is returned.

This method is a job.

*This job MUST produce a file for download.* See :ref:`downloading-files`.

.. 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: options</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>options</h4><span class="badge badge-dark value-type">Type: object</span> <div class="json-default-value">Default:<div class="value">{
      "secretseed": true,
      "pool_keys": false,
      "root_authorized_keys": false
    }</div></div><br/>
    <span class="description"><p>Options controlling what data to include in the configuration backup.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_secretseed">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_secretseed">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_secretseed" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_secretseed" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_secretseed')" type="button"><span class="property-name">secretseed</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_secretseed" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_secretseed" id="Call_parameters_items_i0_secretseed">
    <div class="card-body pl-5">
    <h4>Secretseed</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>Whether to include the secret seed in the configuration backup. The seed decrypts every password, private key and API key the backup contains, so treat a backup that includes it as a secret. A backup saved without it cannot be uploaded.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_pool_keys">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_pool_keys">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_pool_keys" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_pool_keys" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_pool_keys')" type="button"><span class="property-name">pool_keys</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_pool_keys" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_pool_keys" id="Call_parameters_items_i0_pool_keys">
    <div class="card-body pl-5">
    <h4>Pool Keys</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Whether to include encryption keys for storage pools in the backup. IGNORED and deprecated; it does not apply on SCALE systems.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_root_authorized_keys">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_root_authorized_keys">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_root_authorized_keys" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_root_authorized_keys" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_root_authorized_keys')" type="button"><span class="property-name">root_authorized_keys</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_root_authorized_keys" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_root_authorized_keys" id="Call_parameters_items_i0_root_authorized_keys">
    <div class="card-body pl-5">
    <h4>Root Authorized Keys</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Whether to include root user's SSH authorized keys in the backup.</p>
    </span>
    </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/>
    <span class="description"><p>Returns <code>null</code> when the configuration backup is successfully created.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* FULL_ADMIN