> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# /show/backup

```
URL: http://<db.host>:<db.port>/show/backup
```

Shows information about one or more
[backups](../../admin/backup_restore/#database-backup) accessible via the
[data source](../../concepts/data_sources/) specified by input parameter
*datasource\_name*.

## Input Parameter Description

<ParamField body="backup_name" type="string">
  Name of the backup. An empty string or '*' will show all existing backups. Any text followed by a '*' will show backups whose name starts with that text.

  The default value is ''.
</ParamField>

<ParamField body="datasource_name" type="string">
  Data source through which the backup is accessible.
</ParamField>

<ParamField body="options" type="map of string to strings">
  Optional parameters.

  The default value is an empty map ( \{} ).

  <Expandable title="options">
    <ParamField body="backup_id">
      ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup.

      The default value is ''.
    </ParamField>

    <ParamField body="backup_type">
      Show backups by type. This option is ignored if *backup\_id* is non-empty.

      The default value is `all`.

      * **all**: Show all backup types.
      * **full**: Show full backups only.
      * **incremental**: Show incremental backups only.
      * **differential**: Show differential backups only.
    </ParamField>

    <ParamField body="show_contents">
      Show the contents of the backed-up snapshots.

      The default value is `none`.

      * **none**: Don't show snapshot contents.
      * **object\_names**: Show backed-up object names, and for tables, sizing detail.
      * **object\_files**: Show backed-up object names, and for tables, sizing detail and associated files.
    </ParamField>

    <ParamField body="no_error_if_not_exists">
      Whether or not to suppress the error if the specified backup does not exist.

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>
  </Expandable>
</ParamField>

## Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query.  Here is a description of the various fields of the wrapper:

<ResponseField name="status" type="String">
  'OK' or 'ERROR'
</ResponseField>

<ResponseField name="message" type="String">
  Empty if success or an error message
</ResponseField>

<ResponseField name="data_type" type="String">
  'show\_backup\_response' or 'none' in case of an error
</ResponseField>

<ResponseField name="data" type="String">
  Empty string
</ResponseField>

<ResponseField name="data_str" type="JSON or String">
  This embedded JSON represents the result of the /show/backup endpoint:

  <Expandable title="data_str">
    <ResponseField name="backup_name" type="string">
      Value of input parameter *backup\_name*.
    </ResponseField>

    <ResponseField name="backup_description" type="array of maps of string to strings">
      Details about the overall backup(s).
    </ResponseField>

    <ResponseField name="backup_ids" type="array of maps of string to strings">
      Details about the individual snapshots contained within the backup(s).
    </ResponseField>

    <ResponseField name="backup_contents" type="array of maps of string to strings">
      When *show\_contents* is *object\_names*, the names of the backed-up objects as well as sizing detail of any backed-up tables; when *object\_files*, the names of the backed-up objects as well as sizing detail and associated data files of any backed-up tables.
    </ResponseField>

    <ResponseField name="deleted_backup_ids" type="array of maps of string to strings">
      IDs of any snapshots that have been deleted from the containing backup(s).
    </ResponseField>

    <ResponseField name="info" type="map of string to strings">
      Additional information.
    </ResponseField>
  </Expandable>

  Empty string in case of an error.
</ResponseField>