1 - AgentBackupRestoreRequest

NameDescriptionSchemaDefault
filesystem_paths
required
List of filesystem backup path
array[RestoreFilesystemPath]
overwrite
optional
Overwrite
Example : True
any of [boolean, null]
restore_server_uuid
required
Restored server ID
Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366
string
restore_target_id
required
Restore target ID
Example : ca1a8e76-af49-40ea-93f8-a5989ffe138b
string

2 - AgentBackupRestoreTargetServerListResponse

NameDescriptionSchemaDefault
contents
optional
Agent Backup restore target list
any of [array[AgentBackupRestoreTargetServerResponse], null]
count
required
Count
Example : 1
integer

3 - AgentBackupRestoreTargetServerResponse

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

4 - AsyncResponse

NameDescriptionSchemaDefault
request_id
required
Request ID
Example :
string
resource
required
Resource
ResourceInfo

5 - BackupAgentCreateRequest

NameDescriptionSchemaDefault
server_uuid
required
Backup Agent target server UUID
Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366
string
tags
optional

any of [array[Tag], null]

6 - BackupAgentDetailResponse

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

7 - BackupAgentListResponse

NameDescriptionSchemaDefault
contents
required
Backup Agent list
any of [array[BackupAgentResponse], null]
count
optional
Count
Example : 1
any of [integer, null]

8 - BackupAgentResponse

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : fnsd89fus0f9ds09f90dshf9dshfds09
any of [string, null]
backup_policy_count
required
Backup policy count
Example : 3
any of [integer, null]
connection_state
required
Backup Agent connection state
Example : SUCCESS
any of [string, null]
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required
Backup Agent ID
Example : BACKUP_AGENT-abcd
any of [string, null]
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Backup Agent Name
Example : agent_abcd12
any of [string, null]
server_backup_agent_ip
required
Server’s Backup Agent IP
Example : 11.22.33.44
any of [string, null]
server_name
required
Backup server name
Example : server-001
any of [string, null]
state
required
Backup Agent state
Example : AVAILABLE
any of [string, null]

9 - BackupAgentTargetListResponse

NameDescriptionSchemaDefault
contents
required
Backup Agent list
any of [array[BackupAgentTargetResponse], null]
count
optional
Count
Example : 1
any of [integer, null]

10 - BackupAgentTargetResponse

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

11 - BackupCreateRequest

NameDescriptionSchemaDefault
encrypt_enabled
optional
Whether to use Encryption
Example : True
booleanTrue
filesystem_paths
optional
List of filesystem backup path
Example : ['/aaa', '/bbb']
any of [array[string], null]
name
required
Backup name
Example : backup-001
string
policy_category
required
Backup policy category
Example : AGENTLESS
enum (AGENTLESS, AGENT)
policy_type
required
Backup policy type
Example : VM_IMAGE
enum (VM_IMAGE, FILESYSTEM)
region
optional
Region
Example : kr-west1
any of [string, null]
retention_period
optional
Backup retention period
Example : WEEK_2
enum (WEEK_2, MONTH_1, MONTH_3, MONTH_6, YEAR_1)WEEK_2
schedules
required
Schedules
array[BackupScheduleCreateRequest]
server_category
required
Backup server category
Example : VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER
enum (VIRTUAL_SERVER, GPU_SERVER, BAREMETAL_SERVER)
server_guid
optional
Backup server GUID
Example : 9ab33c66-3dbd-46cd-b0af-abccd3eb3170
any of [string, null]
server_uuid
required
Backup server UUID
Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366
string
tags
optional

any of [array[Tag], null]

12 - BackupCreateRequest1Dot1

NameDescriptionSchemaDefault
dr_enabled
optional
Whether to use DR
Example : False
any of [boolean, null]
encrypt_enabled
optional
Whether to use Encryption
Example : True
booleanTrue
filesystem_paths
optional
List of filesystem backup path
Example : ['/aaa', '/bbb']
any of [array[string], null]
name
required
Backup name
Example : backup-001
string
policy_category
required
Backup policy category
Example : AGENTLESS
enum (AGENTLESS, AGENT)
policy_type
required
Backup policy type
Example : VM_IMAGE
enum (VM_IMAGE, FILESYSTEM)
region
optional
Region
Example : kr-west1
any of [string, null]
retention_period
optional
Backup retention period
Example : WEEK_2
enum (WEEK_2, MONTH_1, MONTH_3, MONTH_6, YEAR_1)WEEK_2
schedules
required
Schedules
array[BackupScheduleCreateRequest]
server_category
required
Backup server category
Example : VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER
enum (VIRTUAL_SERVER, GPU_SERVER, BAREMETAL_SERVER)
server_guid
optional
Backup server GUID
Example : 9ab33c66-3dbd-46cd-b0af-abccd3eb3170
any of [string, null]
server_uuid
required
Backup server UUID
Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366
string
tags
optional

any of [array[Tag], null]

13 - BackupDetailResponse

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

14 - BackupDetailResponse1Dot1

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

15 - BackupHistoryListResponse

NameDescriptionSchemaDefault
contents
required
Backup history list
any of [array[BackupHistoryResponse], null]
count
required
Count
Example : 1
integer

16 - BackupHistoryResponse

NameDescriptionSchemaDefault
backup_end_time
required
End time
Example : 2024-10-31T14:59:59Z
any of [string (date-time), null]
backup_job_guid
required
Backup job GUID
Example : 3b1da7ba-3f38-45cb-9538-e921826f80d7
any of [string, null]
backup_job_state
required
Backup history state
Example : SUCCESS
string
backup_start_time
required
Start time
Example : 2024-09-30T15:00:00Z
any of [string (date-time), null]
schedule_id
required
Schedule ID
Example : f5b8e22b-0d88-4698-9996-fb44217c8227
string
schedule_name
required
Schedule name
Example : INCREMENTAL_DAILY_15:00:00-chg4By
string

17 - BackupListRegionRelationshipResponse

NameDescriptionSchemaDefault
contents
required
백업 Region 관계 목록
any of [array[BackupRegionRelationshipResponse], null]
count
optional
total count
Example :
any of [integer, null]

18 - BackupListResponse

NameDescriptionSchemaDefault
contents
required
Backup list
any of [array[BackupResponse], null]
count
optional
Count
Example : 1
any of [integer, null]

19 - BackupNameDuplicateResponse

NameDescriptionSchemaDefault
result
required
Result
Example : True
boolean

20 - BackupRegionRelationshipResponse

NameDescriptionSchemaDefault
from_availability_zone
optional
Availability zone name
Example : kr-west1
any of [string, null]
from_region
optional
Region
Example : kr-west1
any of [string, null]
to_availability_zone
optional
Availability zone name
Example : kr-west1
any of [string, null]
to_region
optional
Region
Example : kr-west1
any of [string, null]

21 - BackupReplicationUseUpdateBody

NameDescriptionSchemaDefault
dr_enabled
required
Whether to use DR
Example : False
boolean

22 - BackupResponse

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

23 - BackupRestoreHistoryListResponse

NameDescriptionSchemaDefault
contents
required
Backup restore history list
any of [array[BackupRestoreHistoryResponse], null]
count
required
Count
Example : 1
integer

24 - BackupRestoreHistoryResponse

NameDescriptionSchemaDefault
backup_id
required
Backup ID
Example : 00cd2538fbf94d12b36aabbdd607e974
string
backup_start_time
required
Backup time
Example : 2024-10-28T05:38:48
string (date-time)
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
restore_end_time
required
Restore completion time
Example : 2024-10-28T05:52:47
any of [string (date-time), null]
restore_server_id
required
Restored server ID
Example : 26895cb7-2059-49e7-b6fe-9c9c4b0d3db0
any of [string, null]
restore_server_name
required
Restore server name
Example : restoretest1
string
restore_start_time
required
Restore start time
Example : 2024-10-28T05:52:47
string (date-time)
restore_state
required
Restore state
Example : COMPLETED
enum (COMPLETED, FAILED, INPROGRESS)
schedule_name
required
Schedule name
Example : INCREMENTAL_DAILY_15:00:00-chg4By
string

25 - BackupRestoreRequest

NameDescriptionSchemaDefault
networks
optional
Network info for restore
any of [array[Network], null]
restore_region
optional
Region to restore server
Example : kr-west1
any of [string, null]
restore_server_name
required
Restore server name
Example : restoretest1
Pattern : ^[a-zA-Z0-9-_ ]*$
Minimum length : 1
Maximum length : 63
string
restore_target_id
required
Restore target ID
Example : ca1a8e76-af49-40ea-93f8-a5989ffe138b
string
security_groups
optional
Security Group ID list
Example : ['023c57b14f11483689338d085e061492']
any of [array[string], null]
server_type_id
required
Server type id
Example : s1v1m2
string

26 - BackupRestoreServerNameDuplicateResponse

NameDescriptionSchemaDefault
result
required
Result
Example : True
boolean

27 - BackupRestoreSubnetListResponse

NameDescriptionSchemaDefault
count
required
Count
Example : 1
integer
subnets
optional
List of subnets for restore
any of [array[BackupRestoreSubnetResponse], null]

28 - BackupRestoreSubnetResponse

NameDescriptionSchemaDefault
account_id
required
Account ID
Example : fnsd89fus0f9ds09f90dshf9dshfds09
string
cidr
required
Subnet Cidr
Example : 192.167.1.0/24
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
gateway_ip_address
required
Gateway IP Address
Example : 192.167.1.1
any of [string, null]
id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Subnet Name
Example : subnetName
string
state
required
Subnet state
Example : ACTIVE
string
type
required
Subnet Type
Example : GENERAL
string
vpc_id
required
VPC ID
Example : 7df8abb4912e4709b1cb237daccca7a8
string
vpc_name
required
VPC name
Example : vpcName
string

29 - BackupRestoreTargetDeleteRequest

NameDescriptionSchemaDefault
restore_target_ids
required
Backup restore target ID list
Example : ['ca1a8e76-af49-40ea-93f8-a5989ffe138b']
array[string]

30 - BackupRestoreTargetListResponse

NameDescriptionSchemaDefault
contents
required
Backup restore target list
any of [array[BackupRestoreTargetResponse], null]
count
required
Count
Example : 1
integer

31 - BackupRestoreTargetResponse

NameDescriptionSchemaDefault
backup_start_time
required
Start time
Example : 2024-09-30T15:00:00Z
any of [string (date-time), null]
is_restore_available
required
Whether restore available
Example : true
boolean
restore_target_id
required
Restore target ID
Example : ca1a8e76-af49-40ea-93f8-a5989ffe138b
string
retention_period
required
Backup retention period
Example : WEEK_2
string
schedule_id
required
Schedule ID
Example : f5b8e22b-0d88-4698-9996-fb44217c8227
string
schedule_name
required
Schedule name
Example : INCREMENTAL_DAILY_15:00:00-chg4By
string
usage_gb
required
Backup size(GB)
Example : 123.4
object

32 - BackupScheduleCreateRequest

NameDescriptionSchemaDefault
frequency
required
Schedule frequency type
Example : DAILY
enum (MONTHLY, WEEKLY, DAILY)
start_day
optional
Backup schedule start day
Example : MON
any of [enum (MON, TUE, WED, THU, FRI, SAT, SUN), null]
start_time
required
Backup schedule start time
Example : 09:00:00
string
start_week
optional
Backup schedule start week
Example : WEEK_2
any of [enum (WEEK_1, WEEK_2, WEEK_3, WEEK_4, WEEK_LAST), null]
type
required
Schedule type
Example : FULL
enum (FULL, INCREMENTAL)

33 - BackupScheduleListResponse

NameDescriptionSchemaDefault
contents
required
Backup schedule list
any of [array[BackupScheduleResponse], null]
count
required
Count
Example : 1
integer

34 - BackupScheduleResponse

NameDescriptionSchemaDefault
backup_id
required
Backup ID
Example : 00cd2538fbf94d12b36aabbdd607e974
string
created_at
required
Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required
Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
frequency
required
Schedule frequency type
Example : DAILY
enum (MONTHLY, WEEKLY, DAILY)
id
required
ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required
Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required
Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required
Schedule name
Example : INCREMENTAL_DAILY_15:00:00-chg4By
string
start_day
required
Schedule start day
Example : MON
any of [string, null]
start_time
required
Schedule start time
Example : 14:00:00
any of [string, null]
start_week
required
Schedule start week
Example : WEEK_1
any of [string, null]
state
required
Backup Schedule state
Example : AVAILABLE
string
type
required
Schedule type
Example : FULL
string

35 - BackupTargetListResponse

NameDescriptionSchemaDefault
contents
optional
Backup target list
any of [array[BackupTargetResponse], null]
count
required
Count
Example : 1
integer

36 - BackupTargetResponse

NameDescriptionSchemaDefault
server_guid
required
Backup server GUID
Example : 9ab33c66-3dbd-46cd-b0af-abccd3eb3170
any of [string, null]
server_name
required
Backup server name
Example : server-001
string
server_os_version
required
Server’s OS Type and Version
Example : UBUNTU 22.04
any of [string, null]
server_type
required
Backup server type
Example : s1v1m2
any of [string, null]
server_uuid
required
Backup server UUID
Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366
string

37 - CheckFileSystemDuplicationResponse

NameDescriptionSchemaDefault
result
required
Result
Example : True
boolean

38 - FileSystemPathUpdateRequest

NameDescriptionSchemaDefault
backup_filesystem_paths
required
List of filesystem backup path
Example : ['/aaa', '/bbb']
any of [array[string], string]

39 - InstallFilePathResponse

NameDescriptionSchemaDefault
install_file_path
required
Install file path
Example : http://linux-agent
string

40 - ModifyBackupSchedulesRequest

NameDescriptionSchemaDefault
schedules
required
Backup schedule list
array[BackupScheduleCreateRequest]

41 - Network

NameDescriptionSchemaDefault
subnet_id
required
Subnet ID
Example : 023c57b14f11483689338d085e061492
string

42 - ResourceInfo

NameDescriptionSchemaDefault
id
required
ID
Example :
string
links
optional
Links
Example :
any of [array[object], null]

43 - RestoreFilesystemPath

NameDescriptionSchemaDefault
destination
required
Destination filesystem path
Example : /data
string
source
required
Original filesystem path to be recovered
Example : /data
string

44 - RetentionPeriodUpdateBody

NameDescriptionSchemaDefault
retention_period
required
Backup retention period
Example : WEEK_2
enum (WEEK_2, MONTH_1, MONTH_3, MONTH_6, YEAR_1)

45 - SyncResponse

NameDescriptionSchemaDefault
request_id
required
Request ID
Example :
string
resource
required
Resource
ResourceInfo

46 - Tag

NameDescriptionSchemaDefault
key
required

Example :
string
value
required

Example :
string