---
title: "Back up an account using the pkgacct script"
method: GET
path: "/start_background_pkgacct"
tags: ["Backups", "Backup or Restore"]
---

# Back up an account using the pkgacct script

`GET /start_background_pkgacct`

This function backs up an account with [the pkgacct script](https://go.cpanel.net/pkgacctscript).

**Note:**

- The `/usr/local/cpanel/scripts/pkgacct` script logs results to the `/var/cpanel/pkgacct_sessions/session_id/` directory, where `session_id` represents the backup session's ID.
- The target system streams the output of this function with the `/usr/local/cpanel/whostmgr/docroot/cgi/live_tail_log.cgi` script on the source system. Users should **not** directly call this script.

## Query parameters

- `user` string, username, required
- `compressionsetting` 'compress', nullable
- `incremental` 0 | 1
- `low_priority` 0 | 1
- `mysqlver` string
- `serialized_output` 0 | 1
- `skipacctdb` 0 | 1
- `skipapitokens` 0 | 1
- `skipauthnlinks` 0 | 1
- `skipbwdata` 0 | 1
- `skipdnssec` 0 | 1
- `skipdnszones` 0 | 1
- `skipftpusers` 0 | 1
- `skiphomedir` 0 | 1
- `skiplinkednodes` 0 | 1
- `skiplogs` 0 | 1
- `skipresellerconfig` 0 | 1
- `skipshell` 0 | 1
- `skipvhosttemplates` 0 | 1
- `split` 0 | 1
- `tarroot` string
- `use_backups` 0 | 1

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `complete_master_error_log` string — The name of the master error log. **Note:** The target system streams the output of this file with the `live_tail_log.cgi` script; however, users should **not** directly call this script.
    - `complete_master_log` string — The name of the master log. **Note:** The target system streams the output of this file with the `live_tail_log.cgi` script; however, users should **not** directly call this script.
    - `session_id` string — The backup's session ID.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)