This is the multi-page printable view of this section. Click here to print.
Models
- 1: AgentBackupRestoreRequest
- 2: AgentBackupRestoreTargetServerListResponse
- 3: AgentBackupRestoreTargetServerListResponse1Dot2
- 4: AgentBackupRestoreTargetServerResponse
- 5: AgentBackupRestoreTargetServerResponse1Dot2
- 6: AsyncResponse
- 7: BackupAgentCreateRequest
- 8: BackupAgentCreateRequest1Dot2
- 9: BackupAgentCreateRequest1Dot3
- 10: BackupAgentDetailResponse
- 11: BackupAgentDetailResponse1Dot2
- 12: BackupAgentDetailResponse1Dot3
- 13: BackupAgentListResponse
- 14: BackupAgentListResponse1Dot2
- 15: BackupAgentResponse
- 16: BackupAgentResponse1Dot2
- 17: BackupAgentTargetListResponse
- 18: BackupAgentTargetListResponse1Dot2
- 19: BackupAgentTargetResponse
- 20: BackupAgentTargetResponse1Dot2
- 21: BackupCreateRequest
- 22: BackupCreateRequest1Dot1
- 23: BackupCreateRequest1Dot2
- 24: BackupCreateRequest1Dot3
- 25: BackupDetailResponse
- 26: BackupDetailResponse1Dot1
- 27: BackupDetailResponse1Dot2
- 28: BackupDetailResponse1Dot3
- 29: BackupHistoryListResponse
- 30: BackupHistoryResponse
- 31: BackupListRegionRelationshipResponse
- 32: BackupListRegionRelationshipResponse1Dot3
- 33: BackupListResponse
- 34: BackupNameDuplicateResponse
- 35: BackupRegionRelationshipResponse
- 36: BackupRegionRelationshipResponse1Dot3
- 37: BackupReplicationUseUpdateBody
- 38: BackupResponse
- 39: BackupRestoreHistoryListResponse
- 40: BackupRestoreHistoryResponse
- 41: BackupRestoreRequest
- 42: BackupRestoreRequest1Dot3
- 43: BackupRestoreServerNameDuplicateResponse
- 44: BackupRestoreSubnetListResponse
- 45: BackupRestoreSubnetResponse
- 46: BackupRestoreTargetDeleteRequest
- 47: BackupRestoreTargetListResponse
- 48: BackupRestoreTargetResponse
- 49: BackupScheduleCreateRequest
- 50: BackupScheduleListResponse
- 51: BackupScheduleResponse
- 52: BackupTargetListResponse
- 53: BackupTargetResponse
- 54: CheckFileSystemDuplicationResponse
- 55: FileSystemPathListResponse
- 56: FileSystemPathResponse
- 57: FileSystemPathUpdateRequest
- 58: FileSystemPathUpdateRequest1Dot2
- 59: InstallFilePathResponse
- 60: MediaServer
- 61: ModifyBackupSchedulesRequest
- 62: Network
- 63: ResourceInfo
- 64: RestoreFilesystemPath
- 65: RetentionPeriodUpdateBody
- 66: SyncResponse
- 67: Tag
1 - AgentBackupRestoreRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | Agent Backup restore target list | any of [array[AgentBackupRestoreTargetServerResponse], null] | |
| count required | Count Example : 1 | integer |
3 - AgentBackupRestoreTargetServerListResponse1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | Agent Backup restore target list | any of [array[AgentBackupRestoreTargetServerResponse1Dot2], null] | |
| count required | Count Example : 1 | integer |
4 - AgentBackupRestoreTargetServerResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
5 - AgentBackupRestoreTargetServerResponse1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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_type required | Backup server type Example : s1v1m2 | any of [string, null] | |
| server_uuid required | Backup server UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string |
6 - AsyncResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| request_id required | Request ID Example : | string | |
| resource required | Resource | ResourceInfo |
7 - BackupAgentCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| server_uuid required | Backup Agent target server UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string | |
| tags optional | any of [array[Tag], null] |
8 - BackupAgentCreateRequest1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| server_uuid required | Backup Agent target server UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string | |
| subnet_id optional | Subnet ID Example : 023c57b14f11483689338d085e061492 | any of [string, null] | |
| tags optional | any of [array[Tag], null] |
9 - BackupAgentCreateRequest1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| server_backup_agent_ip required | Server’s Backup Agent IP Example : 11.22.33.44 | any of [string, null] | |
| server_uuid required | Backup Agent target server UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string | |
| subnet_id optional | Subnet ID Example : 023c57b14f11483689338d085e061492 | any of [string, null] | |
| tags optional | any of [array[Tag], null] | ||
| zone required | Availability zone name Example : kr-west1-a | any of [string, null] |
10 - BackupAgentDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
11 - BackupAgentDetailResponse1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 | |
| media_servers required | Backup Agent Media Server list | any of [array[MediaServer], 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_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] | |
| subnet_id required | Subnet ID Example : | any of [string, null] | |
| subnet_name required | Subnet Name Example : | any of [string, null] |
12 - BackupAgentDetailResponse1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 | |
| is_server_deleted optional | Whether the original server has been deleted Example : False | any of [boolean, null] | |
| media_servers required | Backup Agent Media Server list | any of [array[MediaServer], 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] | |
| region optional | Region Example : kr-west1 | 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] | |
| subnet_id required | Subnet ID Example : | any of [string, null] | |
| subnet_name required | Subnet Name Example : | any of [string, null] | |
| zone optional | Availability zone name Example : kr-west1-a | any of [string, null] |
13 - BackupAgentListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup Agent list | any of [array[BackupAgentResponse], null] | |
| count optional | Count Example : 1 | any of [integer, null] |
14 - BackupAgentListResponse1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup Agent list | any of [array[BackupAgentResponse1Dot2], null] | |
| count optional | Count Example : 1 | any of [integer, null] |
15 - BackupAgentResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] |
16 - BackupAgentResponse1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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_category required | Backup server category Example : VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER | 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] |
17 - BackupAgentTargetListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup Agent list | any of [array[BackupAgentTargetResponse], null] | |
| count optional | Count Example : 1 | any of [integer, null] |
18 - BackupAgentTargetListResponse1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup Agent list | any of [array[BackupAgentTargetResponse1Dot2], null] | |
| count optional | Count Example : 1 | any of [integer, null] |
19 - BackupAgentTargetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| server_backup_agent_ip required | Server’s Backup Agent IP Example : 11.22.33.44 | any of [string, null] | |
| 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 |
20 - BackupAgentTargetResponse1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| server_backup_agent_ip required | Server’s Backup Agent IP Example : 11.22.33.44 | any of [string, null] | |
| server_name required | Backup Agent target server name Example : server-001 | string | |
| server_state required | Backup server state Example : RUNNING | string | |
| server_type required | Backup server type Example : s1v1m2 | any of [string, null] | |
| server_uuid required | Backup Agent target server UUID Example : 89f5ef44-1021-4a5c-8e06-fbb289eac366 | string | |
| vpc_id optional | VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | any of [string, null] |
21 - BackupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| encrypt_enabled optional | Whether to use Encryption Example : True | boolean | True |
| 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, FILE_STORAGE) | |
| region optional | For Agentless Backup, this is the region where the backup is stored. For Agent Backup, this is the region to which the backup will be replicated. 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] |
22 - BackupCreateRequest1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| dr_enabled optional | Whether to use DR Example : False | any of [boolean, null] | |
| encrypt_enabled optional | Whether to use Encryption Example : True | boolean | True |
| 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, FILE_STORAGE) | |
| region optional | For Agentless Backup, this is the region where the backup is stored. For Agent Backup, this is the region to which the backup will be replicated. 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] |
23 - BackupCreateRequest1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| dr_enabled optional | Whether to use DR Example : False | any of [boolean, null] | |
| encrypt_enabled optional | Whether to use Encryption Example : True | boolean | True |
| filesystem_paths optional | List of filesystem backup path Example : ['/aaa', '/bbb'] | any of [array[string], null] | |
| is_all_filesystem optional | Whether to target the all filesystem Example : False | any of [boolean, 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, FILE_STORAGE) | |
| region optional | For Agentless Backup, this is the region where the backup is stored. For Agent Backup, this is the region to which the backup will be replicated. 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] |
24 - BackupCreateRequest1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| dr_enabled optional | Whether to use DR Example : False | any of [boolean, null] | |
| encrypt_enabled optional | Whether to use Encryption Example : True | boolean | True |
| filesystem_paths optional | List of filesystem backup path Example : ['/aaa', '/bbb'] | any of [array[string], null] | |
| is_all_filesystem optional | Whether to target the all filesystem Example : False | any of [boolean, 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, FILE_STORAGE) | |
| region optional | For Agentless Backup, this is the region where the backup is stored. For Agent Backup, this is the region to which the backup will be replicated. 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] | ||
| zone optional | For Agentless Backup, this is the zone where the backup is stored. For Agent Backup, this is the zone to which the backup will be replicated. Example : | any of [string, null] |
25 - BackupDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
26 - BackupDetailResponse1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
27 - BackupDetailResponse1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 | |
| is_all_filesystem optional | Whether to target the all filesystem Example : False | any of [boolean, 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 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 |
28 - BackupDetailResponse1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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] | |
| dr_zone optional | Availability zone name Example : kr-west1-a | 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 | |
| is_all_filesystem optional | Whether to target the all filesystem Example : False | any of [boolean, null] | |
| is_server_deleted optional | Whether the original server has been deleted Example : False | any of [boolean, 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 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 | |
| server_zone optional | Availability zone name Example : kr-west1-a | any of [string, null] | |
| state required | Backup state Example : AVAILABLE | string | |
| zone optional | Availability zone name Example : kr-west1-a | any of [string, null] |
29 - BackupHistoryListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup history list | any of [array[BackupHistoryResponse], null] | |
| count required | Count Example : 1 | integer |
30 - BackupHistoryResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
31 - BackupListRegionRelationshipResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | 백업 Region 관계 목록 | any of [array[BackupRegionRelationshipResponse], null] | |
| count optional | total count Example : | any of [integer, null] |
32 - BackupListRegionRelationshipResponse1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | 백업 Region 관계 목록 | any of [array[BackupRegionRelationshipResponse1Dot3], null] | |
| count optional | total count Example : | any of [integer, null] |
33 - BackupListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup list | any of [array[BackupResponse], null] | |
| count optional | Count Example : 1 | any of [integer, null] |
34 - BackupNameDuplicateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| result required | Result Example : True | boolean |
35 - BackupRegionRelationshipResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| from_availability_zone optional | Availability zone name Example : kr-west1-a | 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-a | any of [string, null] | |
| to_region optional | Region Example : kr-west1 | any of [string, null] |
36 - BackupRegionRelationshipResponse1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| from_region optional | Region Example : kr-west1 | any of [string, null] | |
| from_zone optional | Availability zone name Example : kr-west1-a | any of [string, null] | |
| to_region optional | Region Example : kr-west1 | any of [string, null] | |
| to_zone optional | Availability zone name Example : kr-west1-a | any of [string, null] |
37 - BackupReplicationUseUpdateBody
| Name | Description | Schema | Default |
|---|---|---|---|
| dr_enabled required | Whether to use DR Example : False | boolean |
38 - BackupResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
39 - BackupRestoreHistoryListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup restore history list | any of [array[BackupRestoreHistoryResponse], null] | |
| count required | Count Example : 1 | integer |
40 - BackupRestoreHistoryResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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, PARTIAL_SUCCESS) | |
| schedule_name required | Schedule name Example : INCREMENTAL_DAILY_15:00:00-chg4By | string |
41 - BackupRestoreRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : restoretest1Pattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum 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 |
42 - BackupRestoreRequest1Dot3
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : restoretest1Pattern : ^[a-zA-Z0-9-_ ]*$Minimum length : 1Maximum length : 63 | string | |
| restore_target_id required | Restore target ID Example : ca1a8e76-af49-40ea-93f8-a5989ffe138b | string | |
| restore_zone optional | Availability zone name Example : kr-west1-a | any of [string, null] | |
| security_groups optional | Security Group ID list Example : ['023c57b14f11483689338d085e061492'] | any of [array[string], null] | |
| server_type_id required | Server type id Example : s1v1m2 | string |
43 - BackupRestoreServerNameDuplicateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| result required | Result Example : True | boolean |
44 - BackupRestoreSubnetListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | Count Example : 1 | integer | |
| subnets optional | List of subnets for restore | any of [array[BackupRestoreSubnetResponse], null] |
45 - BackupRestoreSubnetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 : PUBLIC | string | |
| vpc_id required | VPC ID Example : 7df8abb4912e4709b1cb237daccca7a8 | string | |
| vpc_name required | VPC name Example : vpcName | string |
46 - BackupRestoreTargetDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| restore_target_ids required | Backup restore target ID list Example : ['ca1a8e76-af49-40ea-93f8-a5989ffe138b'] | array[string] |
47 - BackupRestoreTargetListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup restore target list | any of [array[BackupRestoreTargetResponse], null] | |
| count required | Count Example : 1 | integer |
48 - BackupRestoreTargetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
49 - BackupScheduleCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| 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) |
50 - BackupScheduleListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | Backup schedule list | any of [array[BackupScheduleResponse], null] | |
| count required | Count Example : 1 | integer |
51 - BackupScheduleResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
52 - BackupTargetListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | Backup target list | any of [array[BackupTargetResponse], null] | |
| count required | Count Example : 1 | integer |
53 - BackupTargetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| 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 |
54 - CheckFileSystemDuplicationResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| result required | Result Example : True | boolean |
55 - FileSystemPathListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents required | List of filesystem backup path | any of [array[FileSystemPathResponse], null] | |
| count optional | Count Example : 1 | any of [integer, null] |
56 - FileSystemPathResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Filesystem Path ID Example : /data/_1768885200 | string | |
| item_type required | Filesystem Type Example : DIR | FILE | string | |
| name required | Filesystem Name Example : data/ | string | |
| path required | Filesystem Path Example : / | any of [string, null] |
57 - FileSystemPathUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| backup_filesystem_paths required | List of filesystem backup path Example : ['/aaa', '/bbb'] | any of [array[string], string] |
58 - FileSystemPathUpdateRequest1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| backup_filesystem_paths optional | List of filesystem backup path Example : ['/aaa', '/bbb'] | any of [array[string], string, null] | |
| is_all_filesystem optional | Whether to target the all filesystem Example : False | any of [boolean, null] |
59 - InstallFilePathResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| install_file_path required | Install file path Example : http://linux-agent | string |
60 - MediaServer
| Name | Description | Schema | Default |
|---|---|---|---|
| ip_address required | Media Server IP Example : | string | |
| name required | Media Server name Example : | string |
61 - ModifyBackupSchedulesRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| schedules required | Backup schedule list | array[BackupScheduleCreateRequest] |
62 - Network
| Name | Description | Schema | Default |
|---|---|---|---|
| subnet_id required | Subnet ID Example : 023c57b14f11483689338d085e061492 | string |
63 - ResourceInfo
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | ID Example : | string | |
| links optional | Links Example : | any of [array[object], null] |
64 - RestoreFilesystemPath
| Name | Description | Schema | Default |
|---|---|---|---|
| destination required | Destination filesystem path Example : / | string | |
| source required | Original filesystem path to be recovered Example : / | string |
65 - RetentionPeriodUpdateBody
| Name | Description | Schema | Default |
|---|---|---|---|
| retention_period required | Backup retention period Example : WEEK_2 | enum (WEEK_2, MONTH_1, MONTH_3, MONTH_6, YEAR_1) |
66 - SyncResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| request_id required | Request ID Example : | string | |
| resource required | Resource | ResourceInfo |
67 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Example : | string | |
| value required | Example : | string |