---
title: "Back up cPanel account via SCP with password"
method: GET
path: "/Backup/fullbackup_to_scp_with_password"
tags: ["Backup"]
---

# Back up cPanel account via SCP with password

`GET /Backup/fullbackup_to_scp_with_password`

This function creates a full backup to a remote server via the secure copy protocol (`scp`) command with a password. The system creates a file in the `backup-MM.DD.YYYY_HH-mm-ss.tar.gz` filename format.

## Query parameters

- `host` union, required
  - string, ipv4 — A valid ipv4 address.
  - string, hostname — A valid hostname.
- `password` string, required
- `username` string, required
- `directory` string
- `email` string, email
- `homedir` 'include' | 'skip'
- `port` integer

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object
      - `pid` string — The backup's process identifier.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/versions/632e2f8e6d04/schema)