docker.list_backups
===================

List existing app backups.

.. 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>
    </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>DockerBackupInfo</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Object mapping backup names to their detailed information.</p>
    </span>
    <div class="accordion" id="accordionReturn_value_additionalProperties">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties')" type="button"><em><span class="property-name">Additional Properties</span></em></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties" id="Return_value_additionalProperties">
    <div class="card-body pl-5"><p class="additional-properties">Each additional property must conform to the following schema</p>
    <h4>BackupInfo</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_additionalProperties_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_name" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_name" id="Return_value_additionalProperties_name">
    <div class="card-body pl-5">
    <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Name of the backup.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_additionalProperties_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_apps">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_apps">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_apps" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_apps" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_apps')" type="button"><span class="property-name">apps</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_apps" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_apps" id="Return_value_additionalProperties_apps">
    <div class="card-body pl-5">
    <h4>Apps</h4><span class="badge badge-dark value-type">Type: array of object</span><br/>
    <span class="description"><p>Array of applications included in this backup.</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="Return_value_additionalProperties_apps_items">
    <h4>AppInfo</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_additionalProperties_apps_items_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_apps_items_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_apps_items_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_apps_items_id" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_apps_items_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_apps_items_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_apps_items_id" id="Return_value_additionalProperties_apps_items_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Unique identifier of the application.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_additionalProperties_apps_items_id_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_apps_items_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_apps_items_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_apps_items_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_apps_items_name" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_apps_items_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_apps_items_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_apps_items_name" id="Return_value_additionalProperties_apps_items_name">
    <div class="card-body pl-5">
    <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Human-readable name of the application.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_additionalProperties_apps_items_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_apps_items_state">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_apps_items_state">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_apps_items_state" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_apps_items_state" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_apps_items_state')" type="button"><span class="property-name">state</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_apps_items_state" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_apps_items_state" id="Return_value_additionalProperties_apps_items_state">
    <div class="card-body pl-5">
    <h4>State</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Current running state of the application.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_additionalProperties_apps_items_state_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_snapshot_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_snapshot_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_snapshot_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_snapshot_name" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_snapshot_name')" type="button"><span class="property-name">snapshot_name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_snapshot_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_snapshot_name" id="Return_value_additionalProperties_snapshot_name">
    <div class="card-body pl-5">
    <h4>Snapshot Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>ZFS snapshot name associated with this backup.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_additionalProperties_snapshot_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_created_on">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_created_on">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_created_on" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_created_on" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_created_on')" type="button"><span class="property-name">created_on</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_created_on" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_created_on" id="Return_value_additionalProperties_created_on">
    <div class="card-body pl-5">
    <h4>Created On</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Timestamp when the backup was created.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_additionalProperties_created_on_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_additionalProperties_backup_path">
    <div class="card">
    <div class="card-header" id="headingReturn_value_additionalProperties_backup_path">
    <h2 class="mb-0">
    <button aria-controls="Return_value_additionalProperties_backup_path" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_additionalProperties_backup_path" data-toggle="collapse" onclick="setAnchor('#Return_value_additionalProperties_backup_path')" type="button"><span class="property-name">backup_path</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_additionalProperties_backup_path" class="collapse property-definition-div" data-parent="#accordionReturn_value_additionalProperties_backup_path" id="Return_value_additionalProperties_backup_path">
    <div class="card-body pl-5">
    <h4>Backup Path</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Filesystem path where the backup is stored.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_additionalProperties_backup_path_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* DOCKER_READ

