> ## 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.

# /drop/backup

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

Deletes one or more existing database
[backups](../../admin/backup_restore/#database-backup) and contained
snapshots, accessible via the [data sink](../../concepts/data_sinks/)
specified by input parameter *datasink\_name*.

## Input Parameter Description

<ParamField body="backup_name" type="string">
  Name of the backup to be deleted. An empty string or '*' will delete all existing backups. Any text followed by a '*' will delete backups whose name starts with that text.  When deleting multiple backups, *delete\_all\_backups* must be set to *true*.
</ParamField>

<ParamField body="datasink_name" type="string">
  Data sink 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="dry_run">
      Whether or not to perform a dry run of a backup deletion.

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="delete_all_backups">
      Allow multiple backups to be deleted if *true* and multiple backup names are found matching input parameter *backup\_name*.

      The default value is `false`.

      The supported values are:

      * true
      * false
    </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">
  'drop\_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 /drop/backup endpoint:

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

    <ResponseField name="backup_names" type="array of strings">
      Names of backups that were deleted.
    </ResponseField>

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

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