This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Backup

1: CLIs

1.1: Check Backup Master Connection State

1.1.1: 1.2
1.1.2: 1.1
1.1.3: 1.0

1.2: Check Backup Name Duplicate

1.2.1: 1.2
1.2.2: 1.1
1.2.3: 1.0

1.3: Check Backup Restore Server Name Duplicate

1.3.1: 1.2
1.3.2: 1.1
1.3.3: 1.0

1.4: Check Filesystem Path Duplication

1.4.1: 1.2
1.4.2: 1.1
1.4.3: 1.0

1.5: Create Backup

1.5.1: 1.2
1.5.2: 1.1
1.5.3: 1.0

1.6: Create Backup Agent

1.6.1: 1.2
1.6.2: 1.1
1.6.3: 1.0

1.7: Delete Backup

1.7.1: 1.2
1.7.2: 1.1
1.7.3: 1.0

1.8: Delete Backup Agent

1.8.1: 1.2
1.8.2: 1.1
1.8.3: 1.0

1.9: Delete Backup Restore Target

1.9.1: 1.2
1.9.2: 1.1
1.9.3: 1.0

1.10: List Agent Backup Restore Target Servers

1.10.1: 1.2
1.10.2: 1.1
1.10.3: 1.0

1.11: List Backup Agents

1.11.1: 1.2
1.11.2: 1.1
1.11.3: 1.0

1.12: List Backup Histories

1.12.1: 1.2
1.12.2: 1.1
1.12.3: 1.0

1.13: List Backup Region Relationship

1.13.1: 1.2
1.13.2: 1.1
1.13.3: 1.0

1.14: List Backup Restore Histories

1.14.1: 1.2
1.14.2: 1.1
1.14.3: 1.0

1.15: List Backup Restore Subnets

1.15.1: 1.2
1.15.2: 1.1
1.15.3: 1.0

1.16: List Backup Restore Targets

1.16.1: 1.2
1.16.2: 1.1
1.16.3: 1.0

1.17: List Backup Schedules

1.17.1: 1.2
1.17.2: 1.1
1.17.3: 1.0

1.18: List Backup Targets

1.18.1: 1.2
1.18.2: 1.1
1.18.3: 1.0

1.19: List Backups

1.19.1: 1.2
1.19.2: 1.1
1.19.3: 1.0

1.20: List Filesystem Path

1.20.1: 1.2

1.21: List Targets of Backup Agent

1.21.1: 1.2
1.21.2: 1.1
1.21.3: 1.0

1.22: Manual Backup

1.22.1: 1.2
1.22.2: 1.1
1.22.3: 1.0

1.23: Restore Agent Backup

1.23.1: 1.2
1.23.2: 1.1
1.23.3: 1.0

1.24: Restore Backup

1.24.1: 1.2
1.24.2: 1.1
1.24.3: 1.0

1.25: Set Backup Schedule

1.25.1: 1.2
1.25.2: 1.1
1.25.3: 1.0

1.26: Set Filesystem Path

1.26.1: 1.2
1.26.2: 1.1
1.26.3: 1.0

1.27: Show Backup

1.27.1: 1.2
1.27.2: 1.1
1.27.3: 1.0

1.28: Show Backup Agent

1.28.1: 1.2
1.28.2: 1.1
1.28.3: 1.0

1.29: Show Backup Agent Install File Path

1.29.1: 1.2
1.29.2: 1.1
1.29.3: 1.0

1.30: Update Replication Use

1.30.1: 1.2
1.30.2: 1.1
1.30.3: 1.0

1.31: Update Retention Period

1.31.1: 1.2
1.31.2: 1.1
1.31.3: 1.0

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Backup service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Status	Not Before
1.2	CURRENT	-
1.1	DEPRECATED	20260531
1.0	DEPRECATED	20260331

1 - CLIs

1.1 - Check Backup Master Connection State

1.1.1 - 1.2

scpcli backup backup agent connection state check
--backup_agent_id <value>

Description

Check Backup master connection state.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.1.2 - 1.1

scpcli backup backup agent connection state check
--backup_agent_id <value>

Description

Check Backup master connection state.

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
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.1.3 - 1.0

scpcli backup backup agent connection state check
--backup_agent_id <value>

Description

Check Backup master connection state.

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
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.2 - Check Backup Name Duplicate

1.2.1 - 1.2

scpcli backup backup name duplicate check
--backup_name <value>

Description

Check for duplicate backup names.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_name required	string	Backup name	`backup-001`

Responses

Name	Description	Example
result	Result	True

1.2.2 - 1.1

scpcli backup backup name duplicate check
--backup_name <value>

Description

Check for duplicate backup names.

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
backup_name required	string	Backup name	`backup-001`

Responses

Name	Description	Example
result	Result	True

1.2.3 - 1.0

scpcli backup backup name duplicate check
--backup_name <value>

Description

Check for duplicate backup names.

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
backup_name required	string	Backup name	`backup-001`

Responses

Name	Description	Example
result	Result	True

1.3 - Check Backup Restore Server Name Duplicate

1.3.1 - 1.2

scpcli backup backup restore server name duplicate check
--restore_server_name <value>

Description

Check for duplicate restore server name.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
restore_server_name required	string	Restore server name	`restoretest1`

Responses

Name	Description	Example
result	Result	True

1.3.2 - 1.1

scpcli backup backup restore server name duplicate check
--restore_server_name <value>

Description

Check for duplicate restore server name.

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
restore_server_name required	string	Restore server name	`restoretest1`

Responses

Name	Description	Example
result	Result	True

1.3.3 - 1.0

scpcli backup backup restore server name duplicate check
--restore_server_name <value>

Description

Check for duplicate restore server name.

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
restore_server_name required	string	Restore server name	`restoretest1`

Responses

Name	Description	Example
result	Result	True

1.4 - Check Filesystem Path Duplication

1.4.1 - 1.2

scpcli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>

Description

Check filesystem path duplication.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_uuid required	string	Backup server UUID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
filesystem_path required	string	Filesystem backup path	`/aaa`

Responses

Name	Description	Example
result	Result	True

1.4.2 - 1.1

scpcli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>

Description

Check filesystem path duplication.

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`
filesystem_path required	string	Filesystem backup path	`/aaa`

Responses

Name	Description	Example
result	Result	True

1.4.3 - 1.0

scpcli backup backup agent filesystem duplication check
--server_uuid <value>
--filesystem_path <value>

Description

Check filesystem path duplication.

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`
filesystem_path required	string	Filesystem backup path	`/aaa`

Responses

Name	Description	Example
result	Result	True

1.5 - Create Backup

1.5.1 - 1.2

scpcli 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 (CURRENT)

Version	Not Before
1.2	-

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	Region	`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

1.5.2 - 1.1

scpcli 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	Region	`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

1.5.3 - 1.0

scpcli 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	Region	`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

1.6 - Create Backup Agent

1.6.1 - 1.2

scpcli backup backup agent create
--server_uuid <value>
[--subnet_id <value>]
[--tags <value>]

Description

Create a Backup Agent.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_uuid required	string	Backup Agent target server UUID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
subnet_id optional	string	Subnet ID	`023c57b14f11483689338d085e061492`
tags optional	array		`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.6.2 - 1.1

scpcli backup backup agent create
--server_uuid <value>
[--tags <value>]

Description

Create a Backup Agent.

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 Agent target server UUID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
tags optional	array		`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.6.3 - 1.0

scpcli backup backup agent create
--server_uuid <value>
[--tags <value>]

Description

Create a Backup Agent.

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 Agent target server UUID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
tags optional	array		`'{"key": "", "value": ""}'`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.7 - Delete Backup

1.7.1 - 1.2

scpcli backup backup delete
--backup_id <value>

Description

Terminate the Backup.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

1.7.2 - 1.1

scpcli backup backup delete
--backup_id <value>

Description

Terminate the 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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

1.7.3 - 1.0

scpcli backup backup delete
--backup_id <value>

Description

Terminate the 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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

1.8 - Delete Backup Agent

1.8.1 - 1.2

scpcli backup backup agent delete
--backup_agent_id <value>

Description

Terminate the Backup Agent.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

1.8.2 - 1.1

scpcli backup backup agent delete
--backup_agent_id <value>

Description

Terminate the Backup Agent.

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
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

1.8.3 - 1.0

scpcli backup backup agent delete
--backup_agent_id <value>

Description

Terminate the Backup Agent.

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
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

1.9 - Delete Backup Restore Target

1.9.1 - 1.2

scpcli backup backup restore target delete
--backup_id <value>
--restore_target_ids <value>

Description

Delete Backup restore target.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
restore_target_ids required	array	Backup restore target ID list	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`

1.9.2 - 1.1

scpcli backup backup restore target delete
--backup_id <value>
--restore_target_ids <value>

Description

Delete Backup restore target.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
restore_target_ids required	array	Backup restore target ID list	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`

1.9.3 - 1.0

scpcli backup backup restore target delete
--backup_id <value>
--restore_target_ids <value>

Description

Delete Backup restore target.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
restore_target_ids required	array	Backup restore target ID list	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`

1.10 - List Agent Backup Restore Target Servers

1.10.1 - 1.2

scpcli backup agent backup restore target server list
--backup_id <value>
[--server_name <value>]
[--page <value>]
[--size <value>]

Description

List Agent Backup restore target servers.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
server_name optional	string	Backup server name	`server-001`
page optional	integer	Page	`0`
size optional	integer	Size	`20`

Responses

Name	Description	Example
server_name	Backup server name	server-001
server_os_version	Server’s OS Type and Version	UBUNTU 22.04
server_type	Backup server type	s1v1m2
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

1.10.2 - 1.1

scpcli backup agent backup restore target server list
--backup_id <value>
[--server_name <value>]
[--page <value>]
[--size <value>]

Description

List Agent Backup restore target servers.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
server_name optional	string	Backup server name	`server-001`
page optional	integer	Page	`0`
size optional	integer	Size	`20`

Responses

Name	Description	Example
server_name	Backup server name	server-001
server_os_version	Server’s OS Type and Version	UBUNTU 22.04
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

1.10.3 - 1.0

scpcli backup agent backup restore target server list
--backup_id <value>
[--server_name <value>]
[--page <value>]
[--size <value>]

Description

List Agent Backup restore target servers.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
server_name optional	string	Backup server name	`server-001`
page optional	integer	Page	`0`
size optional	integer	Size	`20`

Responses

Name	Description	Example
server_name	Backup server name	server-001
server_os_version	Server’s OS Type and Version	UBUNTU 22.04
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

1.11 - List Backup Agents

1.11.1 - 1.2

scpcli backup backup agent list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_backup_agent_ip <value>]
[--server_name <value>]

Description

List Backup Agents.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Backup Agent Name	`agent_abcd12`
server_backup_agent_ip optional	string	Server's Backup Agent IP	`11.22.33.44`
server_name optional	string	Backup Agent target server name	`server-001`

Responses

Name	Description	Example
id	Backup Agent ID	BACKUP_AGENT-abcd
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
backup_policy_count	Backup policy count	3
connection_state	Backup Agent connection state	SUCCESS
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup Agent Name	agent_abcd12
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_category	Backup server category	VIRTUAL_SERVER
server_name	Backup server name	server-001
state	Backup Agent state	AVAILABLE

1.11.2 - 1.1

scpcli backup backup agent list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_backup_agent_ip <value>]
[--server_name <value>]

Description

List Backup Agents.

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
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Backup Agent Name	`agent_abcd12`
server_backup_agent_ip optional	string	Server's Backup Agent IP	`11.22.33.44`
server_name optional	string	Backup Agent target server name	`server-001`

Responses

Name	Description	Example
id	Backup Agent ID	BACKUP_AGENT-abcd
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
backup_policy_count	Backup policy count	3
connection_state	Backup Agent connection state	SUCCESS
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup Agent Name	agent_abcd12
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_name	Backup server name	server-001
state	Backup Agent state	AVAILABLE

1.11.3 - 1.0

scpcli backup backup agent list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_backup_agent_ip <value>]
[--server_name <value>]

Description

List Backup Agents.

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
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Backup Agent Name	`agent_abcd12`
server_backup_agent_ip optional	string	Server's Backup Agent IP	`11.22.33.44`
server_name optional	string	Backup Agent target server name	`server-001`

Responses

Name	Description	Example
id	Backup Agent ID	BACKUP_AGENT-abcd
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
backup_policy_count	Backup policy count	3
connection_state	Backup Agent connection state	SUCCESS
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup Agent Name	agent_abcd12
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_name	Backup server name	server-001
state	Backup Agent state	AVAILABLE

1.12 - List Backup Histories

1.12.1 - 1.2

scpcli backup backup history list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--backup_job_state <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

List Backup histories.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_start_time optional	string	Start time	`2024-09-30T15:00:00Z`
backup_end_time optional	string	End time	`2024-10-31T14:59:59Z`
backup_job_state optional	****	Backup history state	`SUCCESS`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`

Responses

Name	Description	Example
backup_end_time	End time	2024-10-31T14:59:59Z
backup_job_guid	Backup job GUID	3b1da7ba-3f38-45cb-9538-e921826f80d7
backup_job_state	Backup history state	SUCCESS
backup_start_time	Start time	2024-09-30T15:00:00Z
schedule_id	Schedule ID	f5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By

1.12.2 - 1.1

scpcli backup backup history list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--backup_job_state <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

List Backup histories.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_start_time optional	string	Start time	`2024-09-30T15:00:00Z`
backup_end_time optional	string	End time	`2024-10-31T14:59:59Z`
backup_job_state optional	****	Backup history state	`SUCCESS`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`

Responses

Name	Description	Example
backup_end_time	End time	2024-10-31T14:59:59Z
backup_job_guid	Backup job GUID	3b1da7ba-3f38-45cb-9538-e921826f80d7
backup_job_state	Backup history state	SUCCESS
backup_start_time	Start time	2024-09-30T15:00:00Z
schedule_id	Schedule ID	f5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By

1.12.3 - 1.0

scpcli backup backup history list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--backup_job_state <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

List Backup histories.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_start_time optional	string	Start time	`2024-09-30T15:00:00Z`
backup_end_time optional	string	End time	`2024-10-31T14:59:59Z`
backup_job_state optional	****	Backup history state	`SUCCESS`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`

Responses

Name	Description	Example
backup_end_time	End time	2024-10-31T14:59:59Z
backup_job_guid	Backup job GUID	3b1da7ba-3f38-45cb-9538-e921826f80d7
backup_job_state	Backup history state	SUCCESS
backup_start_time	Start time	2024-09-30T15:00:00Z
schedule_id	Schedule ID	f5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By

1.13 - List Backup Region Relationship

1.13.1 - 1.2

scpcli backup backup region relationship list
[--from_region <value>]
[--from_availability_zone <value>]
[--to_region <value>]
[--to_availability_zone <value>]
[--backup_master_type <value>]

Description

List Backup Region Relationship.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
from_region optional	string	Region	`kr-west1`
from_availability_zone optional	string	Availability zone name	`kr-west1`
to_region optional	string	Region	`kr-west1`
to_availability_zone optional	string	Availability zone name	`kr-west1`
backup_master_type optional	****	Backup Master type	`AGENTLESS`

Responses

Name	Description	Example
from_availability_zone	Availability zone name	kr-west1
from_region	Region	kr-west1
to_availability_zone	Availability zone name	kr-west1
to_region	Region	kr-west1

1.13.2 - 1.1

scpcli backup backup region relationship list
[--from_region <value>]
[--from_availability_zone <value>]
[--to_region <value>]
[--to_availability_zone <value>]
[--backup_master_type <value>]

Description

List Backup Region Relationship.

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
from_region optional	string	Region	`kr-west1`
from_availability_zone optional	string	Availability zone name	`kr-west1`
to_region optional	string	Region	`kr-west1`
to_availability_zone optional	string	Availability zone name	`kr-west1`
backup_master_type optional	****	Backup Master type	`AGENTLESS`

Responses

Name	Description	Example
from_availability_zone	Availability zone name	kr-west1
from_region	Region	kr-west1
to_availability_zone	Availability zone name	kr-west1
to_region	Region	kr-west1

1.13.3 - 1.0

scpcli backup backup region relationship list
[--from_region <value>]
[--from_availability_zone <value>]
[--to_region <value>]
[--to_availability_zone <value>]

Description

List Backup Region Relationship.

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
from_region optional	string	Region	`kr-west1`
from_availability_zone optional	string	Availability zone name	`kr-west1`
to_region optional	string	Region	`kr-west1`
to_availability_zone optional	string	Availability zone name	`kr-west1`

Responses

Name	Description	Example
from_availability_zone	Availability zone name	kr-west1
from_region	Region	kr-west1
to_availability_zone	Availability zone name	kr-west1
to_region	Region	kr-west1

1.14 - List Backup Restore Histories

1.14.1 - 1.2

scpcli backup backup restore history list
--backup_id <value>
[--page <value>]
[--size <value>]
[--sort <value>]
[--restore_state <value>]
[--start_time <value>]
[--end_time <value>]

Description

List Backup restore histories.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`
restore_state optional	****	Restore state	`COMPLETED`
start_time optional	string	Start time	`2024-09-30T15:00:00Z`
end_time optional	string	End time	`2024-10-31T14:59:59Z`

Responses

Name	Description	Example
backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
backup_start_time	Backup time	2024-10-28T05:38:48
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
restore_end_time	Restore completion time	2024-10-28T05:52:47
restore_server_id	Restored server ID	26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
restore_server_name	Restore server name	restoretest1
restore_start_time	Restore start time	2024-10-28T05:52:47
restore_state	Restore state	COMPLETED
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By

1.14.2 - 1.1

scpcli backup backup restore history list
--backup_id <value>
[--page <value>]
[--size <value>]
[--sort <value>]
[--restore_state <value>]
[--start_time <value>]
[--end_time <value>]

Description

List Backup restore histories.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`
restore_state optional	****	Restore state	`COMPLETED`
start_time optional	string	Start time	`2024-09-30T15:00:00Z`
end_time optional	string	End time	`2024-10-31T14:59:59Z`

Responses

Name	Description	Example
backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
backup_start_time	Backup time	2024-10-28T05:38:48
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
restore_end_time	Restore completion time	2024-10-28T05:52:47
restore_server_id	Restored server ID	26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
restore_server_name	Restore server name	restoretest1
restore_start_time	Restore start time	2024-10-28T05:52:47
restore_state	Restore state	COMPLETED
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By

1.14.3 - 1.0

scpcli backup backup restore history list
--backup_id <value>
[--page <value>]
[--size <value>]
[--sort <value>]
[--restore_state <value>]
[--start_time <value>]
[--end_time <value>]

Description

List Backup restore histories.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`
restore_state optional	****	Restore state	`COMPLETED`
start_time optional	string	Start time	`2024-09-30T15:00:00Z`
end_time optional	string	End time	`2024-10-31T14:59:59Z`

Responses

Name	Description	Example
backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
backup_start_time	Backup time	2024-10-28T05:38:48
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
restore_end_time	Restore completion time	2024-10-28T05:52:47
restore_server_id	Restored server ID	26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
restore_server_name	Restore server name	restoretest1
restore_start_time	Restore start time	2024-10-28T05:52:47
restore_state	Restore state	COMPLETED
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By

1.15 - List Backup Restore Subnets

1.15.1 - 1.2

scpcli backup backup restore subnet list
--backup_id <value>
--region <value>
[--vpc_id <value>]
[--state <value>]

Description

List of subnets to select when restoring to a different location from the original server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
region required	string	Region to restore server	`kr-west1`
vpc_id optional	string	VPC ID	`7df8abb4912e4709b1cb237daccca7a8`
state optional	string	Subnet state	`ACTIVE`

Responses

Name	Description	Example
id	Subnet ID	023c57b14f11483689338d085e061492
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
cidr	Subnet Cidr	192.167.1.0/24
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_address	Gateway IP Address	192.167.1.1
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Subnet Name	subnetName
state	Subnet state	ACTIVE
type	Subnet Type	GENERAL
vpc_id	VPC ID	7df8abb4912e4709b1cb237daccca7a8
vpc_name	VPC name	vpcName

1.15.2 - 1.1

scpcli backup backup restore subnet list
--backup_id <value>
--region <value>
[--vpc_id <value>]
[--state <value>]

Description

List of subnets to select when restoring to a different location from the original server.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
region required	string	Region to restore server	`kr-west1`
vpc_id optional	string	VPC ID	`7df8abb4912e4709b1cb237daccca7a8`
state optional	string	Subnet state	`ACTIVE`

Responses

Name	Description	Example
id	Subnet ID	023c57b14f11483689338d085e061492
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
cidr	Subnet Cidr	192.167.1.0/24
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_address	Gateway IP Address	192.167.1.1
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Subnet Name	subnetName
state	Subnet state	ACTIVE
type	Subnet Type	GENERAL
vpc_id	VPC ID	7df8abb4912e4709b1cb237daccca7a8
vpc_name	VPC name	vpcName

1.15.3 - 1.0

scpcli backup backup restore subnet list
--backup_id <value>
--region <value>
[--vpc_id <value>]
[--state <value>]

Description

List of subnets to select when restoring to a different location from the original server.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
region required	string	Region to restore server	`kr-west1`
vpc_id optional	string	VPC ID	`7df8abb4912e4709b1cb237daccca7a8`
state optional	string	Subnet state	`ACTIVE`

Responses

Name	Description	Example
id	Subnet ID	023c57b14f11483689338d085e061492
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
cidr	Subnet Cidr	192.167.1.0/24
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
gateway_ip_address	Gateway IP Address	192.167.1.1
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Subnet Name	subnetName
state	Subnet state	ACTIVE
type	Subnet Type	GENERAL
vpc_id	VPC ID	7df8abb4912e4709b1cb237daccca7a8
vpc_name	VPC name	vpcName

1.16 - List Backup Restore Targets

1.16.1 - 1.2

scpcli backup backup restore target list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

List Backup restore targets.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_start_time optional	string	Start time	`2024-09-30T15:00:00Z`
backup_end_time optional	string	End time	`2024-10-31T14:59:59Z`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`

Responses

Name	Description	Example
backup_start_time	Start time	2024-09-30T15:00:00Z
is_restore_available	Whether restore available	true
restore_target_id	Restore target ID	ca1a8e76-af49-40ea-93f8-a5989ffe138b
retention_period	Backup retention period	WEEK_2
schedule_id	Schedule ID	f5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By
usage_gb	Backup size(GB)	123.4

1.16.2 - 1.1

scpcli backup backup restore target list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

List Backup restore targets.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_start_time optional	string	Start time	`2024-09-30T15:00:00Z`
backup_end_time optional	string	End time	`2024-10-31T14:59:59Z`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`

Responses

Name	Description	Example
backup_start_time	Start time	2024-09-30T15:00:00Z
is_restore_available	Whether restore available	true
restore_target_id	Restore target ID	ca1a8e76-af49-40ea-93f8-a5989ffe138b
retention_period	Backup retention period	WEEK_2
schedule_id	Schedule ID	f5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By
usage_gb	Backup size(GB)	123.4

1.16.3 - 1.0

scpcli backup backup restore target list
--backup_id <value>
[--backup_start_time <value>]
[--backup_end_time <value>]
[--page <value>]
[--size <value>]
[--sort <value>]

Description

List Backup restore targets.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_start_time optional	string	Start time	`2024-09-30T15:00:00Z`
backup_end_time optional	string	End time	`2024-10-31T14:59:59Z`
page optional	integer	Page	`0`
size optional	integer	Size	`20`
sort optional	string	Sort	`backup_start_time:desc`

Responses

Name	Description	Example
backup_start_time	Start time	2024-09-30T15:00:00Z
is_restore_available	Whether restore available	true
restore_target_id	Restore target ID	ca1a8e76-af49-40ea-93f8-a5989ffe138b
retention_period	Backup retention period	WEEK_2
schedule_id	Schedule ID	f5b8e22b-0d88-4698-9996-fb44217c8227
schedule_name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By
usage_gb	Backup size(GB)	123.4

1.17 - List Backup Schedules

1.17.1 - 1.2

scpcli backup backup schedule list
--backup_id <value>

Description

List Backup schedules.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
frequency	Schedule frequency type	DAILY
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By
start_day	Schedule start day	MON
start_time	Schedule start time	14:00:00
start_week	Schedule start week	WEEK_1
state	Backup Schedule state	AVAILABLE
type	Schedule type	FULL

1.17.2 - 1.1

scpcli backup backup schedule list
--backup_id <value>

Description

List Backup schedules.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
frequency	Schedule frequency type	DAILY
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By
start_day	Schedule start day	MON
start_time	Schedule start time	14:00:00
start_week	Schedule start week	WEEK_1
state	Backup Schedule state	AVAILABLE
type	Schedule type	FULL

1.17.3 - 1.0

scpcli backup backup schedule list
--backup_id <value>

Description

List Backup schedules.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
frequency	Schedule frequency type	DAILY
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Schedule name	INCREMENTAL_DAILY_15:00:00-chg4By
start_day	Schedule start day	MON
start_time	Schedule start time	14:00:00
start_week	Schedule start week	WEEK_1
state	Backup Schedule state	AVAILABLE
type	Schedule type	FULL

1.18 - List Backup Targets

1.18.1 - 1.2

scpcli backup backup target list
--policy_type <value>
--server_category <value>
[--server_name <value>]
[--region <value>]
[--page <value>]
[--size <value>]

Description

List Backup targets.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
policy_type required	****	Backup policy type	`VM_IMAGE`
server_category required	****	Backup server category	```VIRTUAL_SERVER
server_name optional	string	Backup server name	`server-001`
region optional	string	Region	`kr-west1`
page optional	integer	Page	`0`
size optional	integer	Size	`20`

Responses

Name	Description	Example
server_guid	Backup server GUID	9ab33c66-3dbd-46cd-b0af-abccd3eb3170
server_name	Backup server name	server-001
server_os_version	Server’s OS Type and Version	UBUNTU 22.04
server_type	Backup server type	s1v1m2
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

1.18.2 - 1.1

scpcli backup backup target list
--server_category <value>
[--server_name <value>]
[--region <value>]
[--page <value>]
[--size <value>]

Description

List Backup targets.

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_category required	****	Backup server category	```VIRTUAL_SERVER
server_name optional	string	Backup server name	`server-001`
region optional	string	Region	`kr-west1`
page optional	integer	Page	`0`
size optional	integer	Size	`20`

Responses

Name	Description	Example
server_guid	Backup server GUID	9ab33c66-3dbd-46cd-b0af-abccd3eb3170
server_name	Backup server name	server-001
server_os_version	Server’s OS Type and Version	UBUNTU 22.04
server_type	Backup server type	s1v1m2
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

1.18.3 - 1.0

scpcli backup backup target list
--server_category <value>
[--server_name <value>]
[--region <value>]
[--page <value>]
[--size <value>]

Description

List Backup targets.

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_category required	****	Backup server category	```VIRTUAL_SERVER
server_name optional	string	Backup server name	`server-001`
region optional	string	Region	`kr-west1`
page optional	integer	Page	`0`
size optional	integer	Size	`20`

Responses

Name	Description	Example
server_guid	Backup server GUID	9ab33c66-3dbd-46cd-b0af-abccd3eb3170
server_name	Backup server name	server-001
server_os_version	Server’s OS Type and Version	UBUNTU 22.04
server_type	Backup server type	s1v1m2
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

1.19 - List Backups

1.19.1 - 1.2

scpcli backup backup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_name <value>]

Description

List Backups.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Backup name	`backup-001`
server_name optional	string	Backup server name	`server-001`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup name	backup-001
policy_type	Backup policy type	VM_IMAGE
retention_period	Backup retention period	WEEK_2
role_type	Backup role type	ORIGINAL
server_name	Backup server name	server-001
state	Backup state	AVAILABLE

1.19.2 - 1.1

scpcli backup backup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_name <value>]

Description

List Backups.

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
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Backup name	`backup-001`
server_name optional	string	Backup server name	`server-001`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup name	backup-001
policy_type	Backup policy type	VM_IMAGE
retention_period	Backup retention period	WEEK_2
role_type	Backup role type	ORIGINAL
server_name	Backup server name	server-001
state	Backup state	AVAILABLE

1.19.3 - 1.0

scpcli backup backup list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_name <value>]

Description

List Backups.

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
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
name optional	string	Backup name	`backup-001`
server_name optional	string	Backup server name	`server-001`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup name	backup-001
policy_type	Backup policy type	VM_IMAGE
retention_period	Backup retention period	WEEK_2
role_type	Backup role type	ORIGINAL
server_name	Backup server name	server-001
state	Backup state	AVAILABLE

1.20 - List Filesystem Path

1.20.1 - 1.2

scpcli backup backup agent filesystem path list
--backup_id <value>
--path <value>
--restore_target_id <value>

Description

List Filesystem path.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
path required	string	List of filesystem backup path	`/`
restore_target_id required	string	Restore target ID	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`

Responses

Name	Description	Example
id	Filesystem Path ID	/data/_1768885200
item_type	Filesystem Type	DIR
name	Filesystem Name	data/
path	Filesystem Path	/

1.21 - List Targets of Backup Agent

1.21.1 - 1.2

scpcli backup backup agent target list
--server_category <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]

Description

List targets of Backup Agent.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_category required	string	Backup server category	`BAREMETAL_SERVER`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	Sort	-
server_name optional	string	Backup server name	`server-001`

Responses

Name	Description	Example
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_name	Backup Agent target server name	server-001
server_state	Backup server state	RUNNING
server_type	Backup server type	s1v1m2
server_uuid	Backup Agent target server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366
vpc_id	VPC ID	7df8abb4912e4709b1cb237daccca7a8

1.21.2 - 1.1

scpcli backup backup agent target list
--server_category <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]

Description

List targets of Backup Agent.

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_category required	string	Backup server category	`BAREMETAL_SERVER`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	Sort	-
server_name optional	string	Backup server name	`server-001`

Responses

Name	Description	Example
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_name	Backup Agent target server name	server-001
server_state	Backup server state	RUNNING
server_uuid	Backup Agent target server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

1.21.3 - 1.0

scpcli backup backup agent target list
--server_category <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]

Description

List targets of Backup Agent.

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_category required	string	Backup server category	`BAREMETAL_SERVER`
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	Sort	-
server_name optional	string	Backup server name	`server-001`

Responses

Name	Description	Example
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_name	Backup Agent target server name	server-001
server_state	Backup server state	RUNNING
server_uuid	Backup Agent target server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366

1.22 - Manual Backup

1.22.1 - 1.2

scpcli backup backup manual backup create
--backup_id <value>

Description

Perform Manual Backup immediately.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.22.2 - 1.1

scpcli backup backup manual backup create
--backup_id <value>

Description

Perform Manual Backup immediately.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.22.3 - 1.0

scpcli backup backup manual backup create
--backup_id <value>

Description

Perform Manual Backup immediately.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.23 - Restore Agent Backup

1.23.1 - 1.2

scpcli backup agent backup restore
--backup_id <value>
--restore_target_id <value>
--restore_server_uuid <value>
--filesystem_paths <value>
[--overwrite <value>]

Description

Restore the Backup.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
restore_target_id required	string	Restore target ID	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`
restore_server_uuid required	string	Restored server ID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
filesystem_paths required	array	List of filesystem backup path	`'{"destination": "/", "source": "/"}'`
overwrite optional	boolean	Overwrite	`True`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.23.2 - 1.1

scpcli backup agent backup restore
--backup_id <value>
--restore_target_id <value>
--restore_server_uuid <value>
--filesystem_paths <value>
[--overwrite <value>]

Description

Restore the 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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
restore_target_id required	string	Restore target ID	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`
restore_server_uuid required	string	Restored server ID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
filesystem_paths required	array	List of filesystem backup path	`'{"destination": "/", "source": "/"}'`
overwrite optional	boolean	Overwrite	`True`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.23.3 - 1.0

scpcli backup agent backup restore
--backup_id <value>
--restore_target_id <value>
--restore_server_uuid <value>
--filesystem_paths <value>
[--overwrite <value>]

Description

Restore the 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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
restore_target_id required	string	Restore target ID	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`
restore_server_uuid required	string	Restored server ID	`89f5ef44-1021-4a5c-8e06-fbb289eac366`
filesystem_paths required	array	List of filesystem backup path	`'{"destination": "/", "source": "/"}'`
overwrite optional	boolean	Overwrite	`True`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.24 - Restore Backup

1.24.1 - 1.2

scpcli backup backup restore
--backup_id <value>
--server_type_id <value>
--restore_target_id <value>
--restore_server_name <value>
[--networks <value>]
[--restore_region <value>]
[--security_groups <value>]

Description

Restore the Backup.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
server_type_id required	string	Server type id	`s1v1m2`
restore_target_id required	string	Restore target ID	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`
restore_server_name required	string	Restore server name	`restoretest1`
networks optional	array	Network info for restore	`'{"subnet_id": "023c57b14f11483689338d085e061492"}'`
restore_region optional	string	Region to restore server	`kr-west1`
security_groups optional	array	Security Group ID list	`023c57b14f11483689338d085e061492`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.24.2 - 1.1

scpcli backup backup restore
--backup_id <value>
--server_type_id <value>
--restore_target_id <value>
--restore_server_name <value>
[--networks <value>]
[--restore_region <value>]
[--security_groups <value>]

Description

Restore the 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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
server_type_id required	string	Server type id	`s1v1m2`
restore_target_id required	string	Restore target ID	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`
restore_server_name required	string	Restore server name	`restoretest1`
networks optional	array	Network info for restore	`'{"subnet_id": "023c57b14f11483689338d085e061492"}'`
restore_region optional	string	Region to restore server	`kr-west1`
security_groups optional	array	Security Group ID list	`023c57b14f11483689338d085e061492`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.24.3 - 1.0

scpcli backup backup restore
--backup_id <value>
--server_type_id <value>
--restore_target_id <value>
--restore_server_name <value>
[--networks <value>]
[--restore_region <value>]
[--security_groups <value>]

Description

Restore the 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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
server_type_id required	string	Server type id	`s1v1m2`
restore_target_id required	string	Restore target ID	`ca1a8e76-af49-40ea-93f8-a5989ffe138b`
restore_server_name required	string	Restore server name	`restoretest1`
networks optional	array	Network info for restore	`'{"subnet_id": "023c57b14f11483689338d085e061492"}'`
restore_region optional	string	Region to restore server	`kr-west1`
security_groups optional	array	Security Group ID list	`023c57b14f11483689338d085e061492`

Responses

Name	Description	Example
request_id	Request ID
resource	Resource

1.25 - Set Backup Schedule

1.25.1 - 1.2

scpcli backup backup schedule set
--backup_id <value>
--schedules <value>

Description

Set Backup schedule.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
schedules required	array	Backup schedule list	`'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'`

1.25.2 - 1.1

scpcli backup backup schedule set
--backup_id <value>
--schedules <value>

Description

Set Backup schedule.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
schedules required	array	Backup schedule list	`'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'`

1.25.3 - 1.0

scpcli backup backup schedule set
--backup_id <value>
--schedules <value>

Description

Set Backup schedule.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
schedules required	array	Backup schedule list	`'{"frequency": "DAILY", "start_day": "MON", "start_time": "09:00:00", "start_week": "WEEK_2", "type": "FULL"}'`

1.26 - Set Filesystem Path

1.26.1 - 1.2

scpcli backup backup agent filesystem path set
--backup_id <value>
[--backup_filesystem_paths <value>]
[--is_all_filesystem <value>]

Description

Set Filesystem path.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_filesystem_paths optional	array	List of filesystem backup path	`/aaa`
is_all_filesystem optional	boolean	Whether to target the all filesystem	`False`

1.26.2 - 1.1

scpcli backup backup agent filesystem path set
--backup_id <value>
--backup_filesystem_paths <value>

Description

Set Filesystem path.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_filesystem_paths required	array	List of filesystem backup path	`/aaa`

1.26.3 - 1.0

scpcli backup backup agent filesystem path set
--backup_id <value>
--backup_filesystem_paths <value>

Description

Set Filesystem path.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
backup_filesystem_paths required	array	List of filesystem backup path	`/aaa`

1.27 - Show Backup

1.27.1 - 1.2

scpcli backup backup show
--backup_id <value>

Description

Show the detail of Backup.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_agent_id	Backup Agent ID	BACKUP_AGENT-abcd
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
dr_enabled	Whether to use DR
dr_region	DR Region	kr-west1
encrypt_enabled	Whether to use Encryption	False
filesystem_paths	List of filesystem backup path	[’/aaa’, ‘/bbb’]
is_all_filesystem	Whether to target the all filesystem	False
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup name	backup-001
origin_backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
policy_category	Backup policy category	AGENTLESS
policy_type	Backup policy type	VM_IMAGE
region	Region	kr-west1
replica_backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
retention_period	Backup retention period	WEEK_2
role_type	Backup role type	ORIGINAL
server_category	Backup server category	VIRTUAL_SERVER
server_name	Backup server name	server-001
server_os_type	Server’s OS Type	WINDOWS
server_region	Region	kr-west1
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366
state	Backup state	AVAILABLE

1.27.2 - 1.1

scpcli backup backup show
--backup_id <value>

Description

Show the detail of 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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_agent_id	Backup Agent ID	BACKUP_AGENT-abcd
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
dr_enabled	Whether to use DR
dr_region	DR Region	kr-west1
encrypt_enabled	Whether to use Encryption	False
filesystem_paths	List of filesystem backup path	[’/aaa’, ‘/bbb’]
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup name	backup-001
origin_backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
policy_category	Backup policy category	AGENTLESS
policy_type	Backup policy type	VM_IMAGE
region	Region	kr-west1
replica_backup_id	Backup ID	00cd2538fbf94d12b36aabbdd607e974
retention_period	Backup retention period	WEEK_2
role_type	Backup role type	ORIGINAL
server_category	Backup server category	VIRTUAL_SERVER
server_name	Backup server name	server-001
server_os_type	Server’s OS Type	WINDOWS
server_region	Region	kr-west1
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366
state	Backup state	AVAILABLE

1.27.3 - 1.0

scpcli backup backup show
--backup_id <value>

Description

Show the detail of 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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
backup_agent_id	Backup Agent ID	BACKUP_AGENT-abcd
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
encrypt_enabled	Whether to use Encryption	False
filesystem_paths	List of filesystem backup path	[’/aaa’, ‘/bbb’]
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup name	backup-001
policy_category	Backup policy category	AGENTLESS
policy_type	Backup policy type	VM_IMAGE
region	Region	kr-west1
retention_period	Backup retention period	WEEK_2
role_type	Backup role type	ORIGINAL
server_category	Backup server category	VIRTUAL_SERVER
server_name	Backup server name	server-001
server_os_type	Server’s OS Type	WINDOWS
server_region	Region	kr-west1
server_uuid	Backup server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366
state	Backup state	AVAILABLE

1.28 - Show Backup Agent

1.28.1 - 1.2

scpcli backup backup agent show
--backup_agent_id <value>

Description

Show the detail of Backup Agent.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

Responses

Name	Description	Example
ip_address	Media Server IP
name	Media Server name

1.28.2 - 1.1

scpcli backup backup agent show
--backup_agent_id <value>

Description

Show the detail of Backup Agent.

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
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

Responses

Name	Description	Example
id	Backup Agent ID	BACKUP_AGENT-abcd
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
backup_master_ip	Backup Master IP	33.44.55.66
backup_master_name	Backup Master name	backupmastertest
backup_policy_count	Backup policy count	3
connection_check_time	Backup Agent connection check time	2024-11-11T09:13:48Z
connection_state	Backup Agent connection state	SUCCESS
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
install_file_path	Install file path	http://linux-agent
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup Agent Name	agent_abcd12
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_category	Backup server category	VIRTUAL_SERVER
server_gateway_ip	Server Gateway IP	22.33.44.55
server_name	Backup Agent target server name	server-001
server_os_type	Server’s OS Type	WINDOWS
server_uuid	Backup Agent target server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366
state	Backup Agent state	AVAILABLE

1.28.3 - 1.0

scpcli backup backup agent show
--backup_agent_id <value>

Description

Show the detail of Backup Agent.

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
backup_agent_id required	string	Backup Agent ID	`BACKUP_AGENT-abcd`

Responses

Name	Description	Example
id	Backup Agent ID	BACKUP_AGENT-abcd
account_id	Account ID	fnsd89fus0f9ds09f90dshf9dshfds09
backup_master_ip	Backup Master IP	33.44.55.66
backup_master_name	Backup Master name	backupmastertest
backup_policy_count	Backup policy count	3
connection_check_time	Backup Agent connection check time	2024-11-11T09:13:48Z
connection_state	Backup Agent connection state	SUCCESS
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
install_file_path	Install file path	http://linux-agent
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
name	Backup Agent Name	agent_abcd12
server_backup_agent_ip	Server’s Backup Agent IP	11.22.33.44
server_category	Backup server category	VIRTUAL_SERVER
server_gateway_ip	Server Gateway IP	22.33.44.55
server_name	Backup Agent target server name	server-001
server_os_type	Server’s OS Type	WINDOWS
server_uuid	Backup Agent target server UUID	89f5ef44-1021-4a5c-8e06-fbb289eac366
state	Backup Agent state	AVAILABLE

1.29 - Show Backup Agent Install File Path

1.29.1 - 1.2

scpcli backup backup agent install file path show
--os_type <value>

Description

Show Backup Agent Install File Path.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
os_type required	string	OS type	-

Responses

Name	Description	Example
install_file_path	Install file path	http://linux-agent

1.29.2 - 1.1

scpcli backup backup agent install file path show
--os_type <value>

Description

Show Backup Agent Install File Path.

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
os_type required	string	OS type	-

Responses

Name	Description	Example
install_file_path	Install file path	http://linux-agent

1.29.3 - 1.0

scpcli backup backup agent install file path show
--os_type <value>

Description

Show Backup Agent Install File Path.

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
os_type required	string	OS type	-

Responses

Name	Description	Example
install_file_path	Install file path	http://linux-agent

1.30 - Update Replication Use

1.30.1 - 1.2

scpcli backup backup replication use set
--backup_id <value>
--dr_enabled <value>

Description

Update Replication use.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
dr_enabled required	boolean	Whether to use DR	`False`

1.30.2 - 1.1

scpcli backup backup replication use set
--backup_id <value>
--dr_enabled <value>

Description

Update Replication use.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
dr_enabled required	boolean	Whether to use DR	`False`

1.30.3 - 1.0

scpcli backup backup replication use set
--backup_id <value>
--dr_enabled <value>

Description

Update Replication use.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
dr_enabled required	boolean	Whether to use DR	`False`

1.31 - Update Retention Period

1.31.1 - 1.2

scpcli backup backup retention period set
--backup_id <value>
--retention_period <value>

Description

Update the retention period.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
retention_period required	string	Backup retention period	`WEEK_2`

1.31.2 - 1.1

scpcli backup backup retention period set
--backup_id <value>
--retention_period <value>

Description

Update the retention period.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
retention_period required	string	Backup retention period	`WEEK_2`

1.31.3 - 1.0

scpcli backup backup retention period set
--backup_id <value>
--retention_period <value>

Description

Update the retention period.

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
backup_id required	string	Backup ID	`00cd2538fbf94d12b36aabbdd607e974`
retention_period required	string	Backup retention period	`WEEK_2`