This is the multi-page printable view of this section. Click here to print.
Create Backup
1 - 1.3
scp-cli backup backup create
--server_uuid <value>
--server_category <value>
--schedules <value>
--policy_type <value>
--policy_category <value>
--name <value>
[--dr_enabled <value>]
[--encrypt_enabled <value>]
[--filesystem_paths <value>]
[--is_all_filesystem <value>]
[--region <value>]
[--retention_period <value>]
[--server_guid <value>]
[--tags <value>]
[--zone <value>]
Description
Create a Backup.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_uuid required | string | Backup server UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| server_category required | string | Backup server category | ```VIRTUAL_SERVER |
| schedules required | array | Schedules | '{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}' |
| policy_type required | string | Backup policy type | VM_IMAGE |
| policy_category required | string | Backup policy category | AGENTLESS |
| name required | string | Backup name | backup-001 |
| dr_enabled optional | boolean | Whether to use DR | - |
| encrypt_enabled optional | boolean | Whether to use Encryption | True |
| filesystem_paths optional | array | List of filesystem backup path | /aaa |
| is_all_filesystem optional | boolean | Whether to target the all filesystem | - |
| region optional | string | For Agentless Backup, this is the region where the backup is stored. For Agent Backup, this is the region to which the backup will be replicated. | kr-west1 |
| retention_period optional | string | Backup retention period | WEEK_2 |
| server_guid optional | string | Backup server GUID | 9ab33c66-3dbd-46cd-b0af-abccd3eb3170 |
| tags optional | array | '{"key": "", "value": ""}' | |
| zone optional | string | For Agentless Backup, this is the zone where the backup is stored. For Agent Backup, this is the zone to which the backup will be replicated. | - |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| resource | Resource |
2 - 1.2
scp-cli backup backup create
--server_uuid <value>
--server_category <value>
--schedules <value>
--policy_type <value>
--policy_category <value>
--name <value>
[--dr_enabled <value>]
[--encrypt_enabled <value>]
[--filesystem_paths <value>]
[--is_all_filesystem <value>]
[--region <value>]
[--retention_period <value>]
[--server_guid <value>]
[--tags <value>]
Description
Create a Backup.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.2 | 20261231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_uuid required | string | Backup server UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| server_category required | string | Backup server category | ```VIRTUAL_SERVER |
| schedules required | array | Schedules | '{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}' |
| policy_type required | string | Backup policy type | VM_IMAGE |
| policy_category required | string | Backup policy category | AGENTLESS |
| name required | string | Backup name | backup-001 |
| dr_enabled optional | boolean | Whether to use DR | - |
| encrypt_enabled optional | boolean | Whether to use Encryption | True |
| filesystem_paths optional | array | List of filesystem backup path | /aaa |
| is_all_filesystem optional | boolean | Whether to target the all filesystem | - |
| region optional | string | For Agentless Backup, this is the region where the backup is stored. For Agent Backup, this is the region to which the backup will be replicated. | kr-west1 |
| retention_period optional | string | Backup retention period | WEEK_2 |
| server_guid optional | string | Backup server GUID | 9ab33c66-3dbd-46cd-b0af-abccd3eb3170 |
| tags optional | array | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| resource | Resource |
3 - 1.1
scp-cli backup backup create
--server_uuid <value>
--server_category <value>
--schedules <value>
--policy_type <value>
--policy_category <value>
--name <value>
[--dr_enabled <value>]
[--encrypt_enabled <value>]
[--filesystem_paths <value>]
[--region <value>]
[--retention_period <value>]
[--server_guid <value>]
[--tags <value>]
Description
Create a Backup.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_uuid required | string | Backup server UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| server_category required | string | Backup server category | ```VIRTUAL_SERVER |
| schedules required | array | Schedules | '{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}' |
| policy_type required | string | Backup policy type | VM_IMAGE |
| policy_category required | string | Backup policy category | AGENTLESS |
| name required | string | Backup name | backup-001 |
| dr_enabled optional | boolean | Whether to use DR | - |
| encrypt_enabled optional | boolean | Whether to use Encryption | True |
| filesystem_paths optional | array | List of filesystem backup path | /aaa |
| region optional | string | For Agentless Backup, this is the region where the backup is stored. For Agent Backup, this is the region to which the backup will be replicated. | kr-west1 |
| retention_period optional | string | Backup retention period | WEEK_2 |
| server_guid optional | string | Backup server GUID | 9ab33c66-3dbd-46cd-b0af-abccd3eb3170 |
| tags optional | array | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| resource | Resource |
4 - 1.0
scp-cli backup backup create
--server_uuid <value>
--server_category <value>
--schedules <value>
--policy_type <value>
--policy_category <value>
--name <value>
[--encrypt_enabled <value>]
[--filesystem_paths <value>]
[--region <value>]
[--retention_period <value>]
[--server_guid <value>]
[--tags <value>]
Description
Create a Backup.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| server_uuid required | string | Backup server UUID | 89f5ef44-1021-4a5c-8e06-fbb289eac366 |
| server_category required | string | Backup server category | ```VIRTUAL_SERVER |
| schedules required | array | Schedules | '{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}' |
| policy_type required | string | Backup policy type | VM_IMAGE |
| policy_category required | string | Backup policy category | AGENTLESS |
| name required | string | Backup name | backup-001 |
| encrypt_enabled optional | boolean | Whether to use Encryption | True |
| filesystem_paths optional | array | List of filesystem backup path | /aaa |
| region optional | string | For Agentless Backup, this is the region where the backup is stored. For Agent Backup, this is the region to which the backup will be replicated. | kr-west1 |
| retention_period optional | string | Backup retention period | WEEK_2 |
| server_guid optional | string | Backup server GUID | 9ab33c66-3dbd-46cd-b0af-abccd3eb3170 |
| tags optional | array | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| request_id | Request ID | |
| resource | Resource |