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

# admin_backup_begin

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/admin_backup_begin.rs#L18-L21)
pub async fn [admin\_backup\_begin](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/admin-backup-begin.md#method.admin_backup_begin)( \&self, ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[AdminBackupBeginResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.AdminBackupBeginResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Prepares the system for a backup operationPrepares the system for a backup by closing all open file handles after allowing current active jobs to complete. When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using `/admin/backup/end`.

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/admin_backup_begin.rs#L34-L48)
pub async fn [admin\_backup\_begin\_with\_opts](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/admin-backup-begin.md#method.admin_backup_begin_with_opts)( \&self, options: [AdminBackupBeginRequestOptions](https://docs.kinetica.com/content/api/rust/generated/api/struct.AdminBackupBeginRequestOptions.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[AdminBackupBeginResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.AdminBackupBeginResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Prepares the system for a backup operationPrepares the system for a backup by closing all open file handles after allowing current active jobs to complete. When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using `/admin/backup/end`.

##### Arguments

<ul>
  <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/admin_backup_begin.rs#L51-L62)
pub async fn [admin\_backup\_begin\_raw](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/admin-backup-begin.md#method.admin_backup_begin_raw)( \&self, request: &[AdminBackupBeginRequest](https://docs.kinetica.com/content/api/rust/generated/api/struct.AdminBackupBeginRequest.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[AdminBackupBeginResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.AdminBackupBeginResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

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

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/admin_backup_begin.rs#L66-L78)
pub async fn [admin\_backup\_begin\_from\_url](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/admin-backup-begin.md#method.admin_backup_begin_from_url)( \&self, url: &[str](https://doc.rust-lang.org/1.98.1/std/primitive.str.html), request: &[AdminBackupBeginRequest](https://docs.kinetica.com/content/api/rust/generated/api/struct.AdminBackupBeginRequest.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[AdminBackupBeginResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.AdminBackupBeginResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Sends a pre-built [`AdminBackupBeginRequest`](https://docs.kinetica.com/content/api/rust/generated/api/struct.AdminBackupBeginRequest) 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.