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

# create_backup

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/create_backup.rs#L28-L43)
pub async fn [create\_backup](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/create-backup.md#method.create_backup)( \&self, backup\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), backup\_type: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), backup\_objects\_map: [HashMap](https://doc.rust-lang.org/1.98.1/std/collections/hash/map/struct.HashMap.html)\<[String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html)>, datasink\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[CreateBackupResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateBackupResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Create a database backupCreates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by `datasink_name`.

##### Arguments

<ul>
  <li>`backup_name` - Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless recreate is set to true.</li>
  <li>`backup_type` - Type of snapshot to create.</li>
  <li>`backup_objects_map` - Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.</li>
  <li>`datasink_name` - Data sink through which the backup will be stored.</li>
</ul>

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/create_backup.rs#L63-L85)
pub async fn [create\_backup\_with\_opts](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/create-backup.md#method.create_backup_with_opts)( \&self, backup\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), backup\_type: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), backup\_objects\_map: [HashMap](https://doc.rust-lang.org/1.98.1/std/collections/hash/map/struct.HashMap.html)\<[String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html)>, datasink\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), options: [CreateBackupRequestOptions](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateBackupRequestOptions.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[CreateBackupResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateBackupResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Create a database backupCreates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by `datasink_name`.

##### Arguments

<ul>
  <li>`backup_name` - Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless recreate is set to true.</li>
  <li>`backup_type` - Type of snapshot to create.</li>
  <li>`backup_objects_map` - Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.</li>
  <li>`datasink_name` - Data sink through which the backup will be stored.</li>
  <li>`options` - The optional parameters; any left unset take the server’s defaults.</li>
</ul>

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/create_backup.rs#L88-L99)
pub async fn [create\_backup\_raw](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/create-backup.md#method.create_backup_raw)( \&self, request: &[CreateBackupRequest](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateBackupRequest.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[CreateBackupResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateBackupResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Sends a pre-built [`CreateBackupRequest`](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateBackupRequest) to the `/create/backup` endpoint.

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/create_backup.rs#L103-L115)
pub async fn [create\_backup\_from\_url](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/create-backup.md#method.create_backup_from_url)( \&self, url: &[str](https://doc.rust-lang.org/1.98.1/std/primitive.str.html), request: &[CreateBackupRequest](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateBackupRequest.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[CreateBackupResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateBackupResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Sends a pre-built [`CreateBackupRequest`](https://docs.kinetica.com/content/api/rust/generated/api/struct.CreateBackupRequest) to a specific worker URL, bypassing HA head-node selection. Used for multi-head access.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.