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

Return to the regular view of this page.

APIs

1: Check Backup Master Connection State

1.1: 1.1
1.2: 1.0

2: Check Backup Name Duplicate

2.1: 1.1
2.2: 1.0

3: Check Backup Restore Server Name Duplicate

3.1: 1.1
3.2: 1.0

4: Check Filesystem Path Duplication

4.1: 1.1
4.2: 1.0

5: Create Backup

5.1: 1.1
5.2: 1.0

6: Create Backup Agent

6.1: 1.1
6.2: 1.0

7: Delete Backup

7.1: 1.1
7.2: 1.0

8: Delete Backup Agent

8.1: 1.1
8.2: 1.0

9: Delete Backup Restore Target

9.1: 1.1
9.2: 1.0

10: List Agent Backup Restore Target Servers

10.1: 1.1
10.2: 1.0

11: List Backup Agents

11.1: 1.1
11.2: 1.0

12: List Backup Histories

12.1: 1.1
12.2: 1.0

13: List Backup Region Relationship

13.1: 1.1
13.2: 1.0

14: List Backup Restore Histories

14.1: 1.1
14.2: 1.0

15: List Backup Restore Subnets

15.1: 1.1
15.2: 1.0

16: List Backup Restore Targets

16.1: 1.1
16.2: 1.0

17: List Backup Schedules

17.1: 1.1
17.2: 1.0

18: List Backup Targets

18.1: 1.1
18.2: 1.0

19: List Backups

19.1: 1.1
19.2: 1.0

20: List Targets of Backup Agent

20.1: 1.1
20.2: 1.0

21: Manual Backup

21.1: 1.1
21.2: 1.0

22: Restore Agent Backup

22.1: 1.1
22.2: 1.0

23: Restore Backup

23.1: 1.1
23.2: 1.0

24: Set Backup Schedule

24.1: 1.1
24.2: 1.0

25: Set Filesystem Path

25.1: 1.1
25.2: 1.0

26: Show Backup

26.1: 1.1
26.2: 1.0

27: Show Backup Agent

27.1: 1.1
27.2: 1.0

28: Show Backup Agent Install File Path

28.1: 1.1
28.2: 1.0

29: Update Replication Use

29.1: 1.1
29.2: 1.0

30: Update Retention Period

30.1: 1.1
30.2: 1.0

1 - Check Backup Master Connection State

1.1 - 1.1

get /v1/backup-agents/{backup_agent_id}/check-connection-state

Description

Check Backup master connection state.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_agent_id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents/{backup_agent_id}/check-connection-state

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 202

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

1.2 - 1.0

get /v1/backup-agents/{backup_agent_id}/check-connection-state

Description

Check Backup master connection state.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_agent_id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	string	None

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents/{backup_agent_id}/check-connection-state

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 202

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

2 - Check Backup Name Duplicate

2.1 - 1.1

get /v1/backups/check-name-duplication

Description

Check for duplicate backup names.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	backup_name required	Backup name Example : `backup-001`	string	None

Responses

HTTP Code	Description	Schema
200	OK	BackupNameDuplicateResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/check-name-duplication?backup_name={backup_name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "result": true
}

2.2 - 1.0

get /v1/backups/check-name-duplication

Description

Check for duplicate backup names.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	backup_name required	Backup name Example : `backup-001`	string	None

Responses

HTTP Code	Description	Schema
200	OK	BackupNameDuplicateResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/check-name-duplication?backup_name={backup_name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "result": true
}

3 - Check Backup Restore Server Name Duplicate

3.1 - 1.1

get /v1/backups/restore/check-name-duplication

Description

Check for duplicate restore server name.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	restore_server_name required	Restore server name Example : `restoretest1`	string	None

Responses

HTTP Code	Description	Schema
200	OK	BackupRestoreServerNameDuplicateResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/restore/check-name-duplication?restore_server_name={restore_server_name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "result": true
}

3.2 - 1.0

get /v1/backups/restore/check-name-duplication

Description

Check for duplicate restore server name.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	restore_server_name required	Restore server name Example : `restoretest1`	string	None

Responses

HTTP Code	Description	Schema
200	OK	BackupRestoreServerNameDuplicateResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/restore/check-name-duplication?restore_server_name={restore_server_name}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "result": true
}

4 - Check Filesystem Path Duplication

4.1 - 1.1

get /v1/backups/check-filesystem-duplication

Description

Check filesystem path duplication.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	CheckFileSystemDuplicationResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/check-filesystem-duplication?filesystem_path={filesystem_path}&server_uuid={server_uuid}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "result": true
}

4.2 - 1.0

get /v1/backups/check-filesystem-duplication

Description

Check filesystem path duplication.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

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

Responses

HTTP Code	Description	Schema
200	OK	CheckFileSystemDuplicationResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/check-filesystem-duplication?filesystem_path={filesystem_path}&server_uuid={server_uuid}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "result": true
}

5 - Create Backup

5.1 - 1.1

post /v1/backups

Description

Create a Backup.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		BackupCreateRequest1Dot1

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Request body

{
    "dr_enabled": false,
    "encrypt_enabled": true,
    "filesystem_paths": [
        "/aaa",
        "/bbb"
    ],
    "name": "backup-001",
    "policy_category": "AGENTLESS",
    "policy_type": "VM_IMAGE",
    "region": "kr-west1",
    "retention_period": "WEEK_2",
    "schedules": [
        {
            "frequency": "DAILY",
            "start_day": "MON",
            "start_time": "09:00:00",
            "start_week": "WEEK_2",
            "type": "FULL"
        }
    ],
    "server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
    "server_guid": "9ab33c66-3dbd-46cd-b0af-abccd3eb3170",
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

5.2 - 1.0

post /v1/backups

Description

Create a Backup.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		BackupCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Request body

{
    "encrypt_enabled": true,
    "filesystem_paths": [
        "/aaa",
        "/bbb"
    ],
    "name": "backup-001",
    "policy_category": "AGENTLESS",
    "policy_type": "VM_IMAGE",
    "region": "kr-west1",
    "retention_period": "WEEK_2",
    "schedules": [
        {
            "frequency": "DAILY",
            "start_day": "MON",
            "start_time": "09:00:00",
            "start_week": "WEEK_2",
            "type": "FULL"
        }
    ],
    "server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
    "server_guid": "9ab33c66-3dbd-46cd-b0af-abccd3eb3170",
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

6 - Create Backup Agent

6.1 - 1.1

post /v1/backup-agents

Description

Create a Backup Agent.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
body	body required		BackupAgentCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Request body

{
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

6.2 - 1.0

post /v1/backup-agents

Description

Create a Backup Agent.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
body	body required		BackupAgentCreateRequest

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Request body

{
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

7 - Delete Backup

7.1 - 1.1

delete /v1/backups/{backup_id}

Description

Terminate the Backup.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

7.2 - 1.0

delete /v1/backups/{backup_id}

Description

Terminate the Backup.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

8 - Delete Backup Agent

8.1 - 1.1

delete /v1/backup-agents/{backup_agent_id}

Description

Terminate the Backup Agent.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_agent_id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents/{backup_agent_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

8.2 - 1.0

delete /v1/backup-agents/{backup_agent_id}

Description

Terminate the Backup Agent.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_agent_id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents/{backup_agent_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

9 - Delete Backup Restore Target

9.1 - 1.1

delete /v1/backups/{backup_id}/restore-targets

Description

Delete Backup restore target.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		BackupRestoreTargetDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-targets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Request body

{
    "restore_target_ids": [
        "ca1a8e76-af49-40ea-93f8-a5989ffe138b"
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

9.2 - 1.0

delete /v1/backups/{backup_id}/restore-targets

Description

Delete Backup restore target.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		BackupRestoreTargetDeleteRequest

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-targets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Request body

{
    "restore_target_ids": [
        "ca1a8e76-af49-40ea-93f8-a5989ffe138b"
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

10 - List Agent Backup Restore Target Servers

10.1 - 1.1

get /v1/backups/{backup_id}/agent-backup-restore-targets

Description

List Agent Backup restore target servers.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	server_name optional	Backup server name Example : `server-001`	any of [string, null]	None
query	page optional	Page Example : `0`	any of [integer, null]	0
query	size optional	Size Example : `20`	any of [integer, null]	5

Responses

HTTP Code	Description	Schema
200	OK	AgentBackupRestoreTargetServerListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/agent-backup-restore-targets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "server_name": "server-001",
            "server_os_version": "UBUNTU 22.04",
            "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
        }
    ],
    "count": 1
}

10.2 - 1.0

get /v1/backups/{backup_id}/agent-backup-restore-targets

Description

List Agent Backup restore target servers.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	server_name optional	Backup server name Example : `server-001`	any of [string, null]	None
query	page optional	Page Example : `0`	any of [integer, null]	0
query	size optional	Size Example : `20`	any of [integer, null]	5

Responses

HTTP Code	Description	Schema
200	OK	AgentBackupRestoreTargetServerListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/agent-backup-restore-targets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "server_name": "server-001",
            "server_os_version": "UBUNTU 22.04",
            "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
        }
    ],
    "count": 1
}

11 - List Backup Agents

11.1 - 1.1

get /v1/backup-agents

Description

List Backup Agents.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Backup Agent Name Example : `agent_abcd12`	any of [string, null]	None
query	server_backup_agent_ip optional	Server’s Backup Agent IP Example : `11.22.33.44`	any of [string, null]	None
query	server_name optional	Backup Agent target server name Example : `server-001`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupAgentListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
            "backup_policy_count": "3",
            "connection_state": "SUCCESS",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "BACKUP_AGENT-abcd",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "agent_abcd12",
            "server_backup_agent_ip": "11.22.33.44",
            "server_name": "server-001",
            "state": "AVAILABLE"
        }
    ],
    "count": 1
}

11.2 - 1.0

get /v1/backup-agents

Description

List Backup Agents.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Backup Agent Name Example : `agent_abcd12`	any of [string, null]	None
query	server_backup_agent_ip optional	Server’s Backup Agent IP Example : `11.22.33.44`	any of [string, null]	None
query	server_name optional	Backup Agent target server name Example : `server-001`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupAgentListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
            "backup_policy_count": "3",
            "connection_state": "SUCCESS",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "BACKUP_AGENT-abcd",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "agent_abcd12",
            "server_backup_agent_ip": "11.22.33.44",
            "server_name": "server-001",
            "state": "AVAILABLE"
        }
    ],
    "count": 1
}

12 - List Backup Histories

12.1 - 1.1

get /v1/backups/{backup_id}/backup-histories

Description

List Backup histories.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	backup_start_time optional	Start time Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]	None
query	backup_end_time optional	End time Example : `2024-10-31T14:59:59Z`	any of [string (date-time), null]	None
query	backup_job_state optional	Backup history state Example : `SUCCESS`	any of [enum (SUCCESS, PARTIAL_SUCCESS, FAILED, INPROGRESS, ALL), null]	None
query	page optional	Page Example : `0`	integer	0
query	size optional	Size Example : `20`	integer	20
query	sort optional	Sort Example : `backup_start_time:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupHistoryListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/backup-histories

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_end_time": "2024-10-31T14:59:59Z",
            "backup_job_guid": "3b1da7ba-3f38-45cb-9538-e921826f80d7",
            "backup_job_state": "SUCCESS",
            "backup_start_time": "2024-09-30T15:00:00Z",
            "schedule_id": "f5b8e22b-0d88-4698-9996-fb44217c8227",
            "schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By"
        }
    ],
    "count": 1
}

12.2 - 1.0

get /v1/backups/{backup_id}/backup-histories

Description

List Backup histories.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	backup_start_time optional	Start time Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]	None
query	backup_end_time optional	End time Example : `2024-10-31T14:59:59Z`	any of [string (date-time), null]	None
query	backup_job_state optional	Backup history state Example : `SUCCESS`	any of [enum (SUCCESS, PARTIAL_SUCCESS, FAILED, INPROGRESS, ALL), null]	None
query	page optional	Page Example : `0`	integer	0
query	size optional	Size Example : `20`	integer	20
query	sort optional	Sort Example : `backup_start_time:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupHistoryListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/backup-histories

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_end_time": "2024-10-31T14:59:59Z",
            "backup_job_guid": "3b1da7ba-3f38-45cb-9538-e921826f80d7",
            "backup_job_state": "SUCCESS",
            "backup_start_time": "2024-09-30T15:00:00Z",
            "schedule_id": "f5b8e22b-0d88-4698-9996-fb44217c8227",
            "schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By"
        }
    ],
    "count": 1
}

13 - List Backup Region Relationship

13.1 - 1.1

get /v1/backups/region-relationship

Description

List Backup Region Relationship.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	from_region optional	Region Example : `kr-west1`	any of [string, null]	None
query	from_availability_zone optional	Availability zone name Example : `kr-west1`	any of [string, null]	None
query	to_region optional	Region Example : `kr-west1`	any of [string, null]	None
query	to_availability_zone optional	Availability zone name Example : `kr-west1`	any of [string, null]	None
query	backup_master_type optional	Backup Master type Example : `AGENTLESS`	any of [enum (AGENT, AGENTLESS, AGENT_SAP_INT, AGENT_SAP_EXT), null]	AGENTLESS

Responses

HTTP Code	Description	Schema
200	OK	BackupListRegionRelationshipResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/region-relationship

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "from_availability_zone": "kr-west1",
            "from_region": "kr-west1",
            "to_availability_zone": "kr-west1",
            "to_region": "kr-west1"
        }
    ],
    "count": ""
}

13.2 - 1.0

get /v1/backups/region-relationship

Description

List Backup Region Relationship.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	from_region optional	Region Example : `kr-west1`	any of [string, null]	None
query	from_availability_zone optional	Availability zone name Example : `kr-west1`	any of [string, null]	None
query	to_region optional	Region Example : `kr-west1`	any of [string, null]	None
query	to_availability_zone optional	Availability zone name Example : `kr-west1`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupListRegionRelationshipResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/region-relationship

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "from_availability_zone": "kr-west1",
            "from_region": "kr-west1",
            "to_availability_zone": "kr-west1",
            "to_region": "kr-west1"
        }
    ],
    "count": ""
}

14 - List Backup Restore Histories

14.1 - 1.1

get /v1/backups/{backup_id}/restore-histories

Description

List Backup restore histories.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	page optional	Page Example : `0`	any of [integer, null]	0
query	size optional	Size Example : `20`	any of [integer, null]	20
query	sort optional	Sort Example : `backup_start_time:desc`	any of [string, null]	created_at:desc
query	restore_state optional	Restore state Example : `COMPLETED`	any of [enum (COMPLETED, FAILED, INPROGRESS), null]	None
query	start_time optional	Start time Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]	None
query	end_time optional	End time Example : `2024-10-31T14:59:59Z`	any of [string (date-time), null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupRestoreHistoryListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-histories

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_id": "00cd2538fbf94d12b36aabbdd607e974",
            "backup_start_time": "2024-10-28T05:38:48",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "restore_end_time": "2024-10-28T05:52:47",
            "restore_server_id": "26895cb7-2059-49e7-b6fe-9c9c4b0d3db0",
            "restore_server_name": "restoretest1",
            "restore_start_time": "2024-10-28T05:52:47",
            "restore_state": "COMPLETED",
            "schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By"
        }
    ],
    "count": 1
}

14.2 - 1.0

get /v1/backups/{backup_id}/restore-histories

Description

List Backup restore histories.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	page optional	Page Example : `0`	any of [integer, null]	0
query	size optional	Size Example : `20`	any of [integer, null]	20
query	sort optional	Sort Example : `backup_start_time:desc`	any of [string, null]	created_at:desc
query	restore_state optional	Restore state Example : `COMPLETED`	any of [enum (COMPLETED, FAILED, INPROGRESS), null]	None
query	start_time optional	Start time Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]	None
query	end_time optional	End time Example : `2024-10-31T14:59:59Z`	any of [string (date-time), null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupRestoreHistoryListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-histories

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_id": "00cd2538fbf94d12b36aabbdd607e974",
            "backup_start_time": "2024-10-28T05:38:48",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "restore_end_time": "2024-10-28T05:52:47",
            "restore_server_id": "26895cb7-2059-49e7-b6fe-9c9c4b0d3db0",
            "restore_server_name": "restoretest1",
            "restore_start_time": "2024-10-28T05:52:47",
            "restore_state": "COMPLETED",
            "schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By"
        }
    ],
    "count": 1
}

15 - List Backup Restore Subnets

15.1 - 1.1

get /v1/backups/{backup_id}/restore/restorable-subnets

Description

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

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	vpc_id optional	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	state optional	Subnet state Example : `ACTIVE`	any of [string, null]	None
query	region required	Region to restore server Example : `kr-west1`	string	None

Responses

HTTP Code	Description	Schema
200	OK	BackupRestoreSubnetListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/restore/restorable-subnets?region={region}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "count": 1,
    "subnets": [
        {
            "account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
            "cidr": "192.167.1.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "gateway_ip_address": "192.167.1.1",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "subnetName",
            "state": "ACTIVE",
            "type": "GENERAL",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

15.2 - 1.0

get /v1/backups/{backup_id}/restore/restorable-subnets

Description

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

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	vpc_id optional	VPC ID Example : `7df8abb4912e4709b1cb237daccca7a8`	any of [string, null]	None
query	state optional	Subnet state Example : `ACTIVE`	any of [string, null]	None
query	region required	Region to restore server Example : `kr-west1`	string	None

Responses

HTTP Code	Description	Schema
200	OK	BackupRestoreSubnetListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/restore/restorable-subnets?region={region}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "count": 1,
    "subnets": [
        {
            "account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
            "cidr": "192.167.1.0/24",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "gateway_ip_address": "192.167.1.1",
            "id": "023c57b14f11483689338d085e061492",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "subnetName",
            "state": "ACTIVE",
            "type": "GENERAL",
            "vpc_id": "7df8abb4912e4709b1cb237daccca7a8",
            "vpc_name": "vpcName"
        }
    ]
}

16 - List Backup Restore Targets

16.1 - 1.1

get /v1/backups/{backup_id}/restore-targets

Description

List Backup restore targets.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	backup_start_time optional	Start time Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]	None
query	backup_end_time optional	End time Example : `2024-10-31T14:59:59Z`	any of [string (date-time), null]	None
query	page optional	Page Example : `0`	integer	0
query	size optional	Size Example : `20`	integer	20
query	sort optional	Sort Example : `backup_start_time:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupRestoreTargetListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-targets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_start_time": "2024-09-30T15:00:00Z",
            "is_restore_available": "true",
            "restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b",
            "retention_period": "WEEK_2",
            "schedule_id": "f5b8e22b-0d88-4698-9996-fb44217c8227",
            "schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By",
            "usage_gb": "123.4"
        }
    ],
    "count": 1
}

16.2 - 1.0

get /v1/backups/{backup_id}/restore-targets

Description

List Backup restore targets.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
query	backup_start_time optional	Start time Example : `2024-09-30T15:00:00Z`	any of [string (date-time), null]	None
query	backup_end_time optional	End time Example : `2024-10-31T14:59:59Z`	any of [string (date-time), null]	None
query	page optional	Page Example : `0`	integer	0
query	size optional	Size Example : `20`	integer	20
query	sort optional	Sort Example : `backup_start_time:desc`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupRestoreTargetListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-targets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_start_time": "2024-09-30T15:00:00Z",
            "is_restore_available": "true",
            "restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b",
            "retention_period": "WEEK_2",
            "schedule_id": "f5b8e22b-0d88-4698-9996-fb44217c8227",
            "schedule_name": "INCREMENTAL_DAILY_15:00:00-chg4By",
            "usage_gb": "123.4"
        }
    ],
    "count": 1
}

17 - List Backup Schedules

17.1 - 1.1

get /v1/backups/{backup_id}/schedules

Description

List Backup schedules.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

HTTP Code	Description	Schema
200	OK	BackupScheduleListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/schedules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_id": "00cd2538fbf94d12b36aabbdd607e974",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "frequency": "DAILY",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "INCREMENTAL_DAILY_15:00:00-chg4By",
            "start_day": "MON",
            "start_time": "14:00:00",
            "start_week": "WEEK_1",
            "state": "AVAILABLE",
            "type": "FULL"
        }
    ],
    "count": 1
}

17.2 - 1.0

get /v1/backups/{backup_id}/schedules

Description

List Backup schedules.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

HTTP Code	Description	Schema
200	OK	BackupScheduleListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/schedules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "backup_id": "00cd2538fbf94d12b36aabbdd607e974",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "frequency": "DAILY",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "INCREMENTAL_DAILY_15:00:00-chg4By",
            "start_day": "MON",
            "start_time": "14:00:00",
            "start_week": "WEEK_1",
            "state": "AVAILABLE",
            "type": "FULL"
        }
    ],
    "count": 1
}

18 - List Backup Targets

18.1 - 1.1

get /v1/backups/backup-targets

Description

List Backup targets.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	server_name optional	Backup server name Example : `server-001`	any of [string, null]	None
query	server_category required	Backup server category Example : `VIRTUAL_SERVER \| GPU_SERVER \| BAREMETAL_SERVER`	enum (VIRTUAL_SERVER, GPU_SERVER, BAREMETAL_SERVER)	None
query	region optional	Region Example : `kr-west1`	any of [string, null]	None
query	page optional	Page Example : `0`	any of [integer, null]	0
query	size optional	Size Example : `20`	any of [integer, null]	5

Responses

HTTP Code	Description	Schema
200	OK	BackupTargetListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/backup-targets?server_category={server_category}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "server_guid": "9ab33c66-3dbd-46cd-b0af-abccd3eb3170",
            "server_name": "server-001",
            "server_os_version": "UBUNTU 22.04",
            "server_type": "s1v1m2",
            "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
        }
    ],
    "count": 1
}

18.2 - 1.0

get /v1/backups/backup-targets

Description

List Backup targets.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	server_name optional	Backup server name Example : `server-001`	any of [string, null]	None
query	server_category required	Backup server category Example : `VIRTUAL_SERVER \| GPU_SERVER \| BAREMETAL_SERVER`	enum (VIRTUAL_SERVER, GPU_SERVER, BAREMETAL_SERVER)	None
query	region optional	Region Example : `kr-west1`	any of [string, null]	None
query	page optional	Page Example : `0`	any of [integer, null]	0
query	size optional	Size Example : `20`	any of [integer, null]	5

Responses

HTTP Code	Description	Schema
200	OK	BackupTargetListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/backup-targets?server_category={server_category}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "server_guid": "9ab33c66-3dbd-46cd-b0af-abccd3eb3170",
            "server_name": "server-001",
            "server_os_version": "UBUNTU 22.04",
            "server_type": "s1v1m2",
            "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
        }
    ],
    "count": 1
}

19 - List Backups

19.1 - 1.1

get /v1/backups

Description

List Backups.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Backup name Example : `backup-001`	any of [string, null]	None
query	server_name optional	Backup server name Example : `server-001`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "backup-001",
            "policy_type": "VM_IMAGE",
            "retention_period": "WEEK_2",
            "role_type": "ORIGINAL",
            "server_name": "server-001",
            "state": "AVAILABLE"
        }
    ],
    "count": 1
}

19.2 - 1.0

get /v1/backups

Description

List Backups.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	sort Example : `created_at:desc`	any of [string, null]	None
query	name optional	Backup name Example : `backup-001`	any of [string, null]	None
query	server_name optional	Backup server name Example : `server-001`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "backup-001",
            "policy_type": "VM_IMAGE",
            "retention_period": "WEEK_2",
            "role_type": "ORIGINAL",
            "server_name": "server-001",
            "state": "AVAILABLE"
        }
    ],
    "count": 1
}

20 - List Targets of Backup Agent

20.1 - 1.1

get /v1/backup-agents/targets

Description

List targets of Backup Agent.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	Sort Example : `server_name:asc`	any of [string, null]	server_name:asc
query	server_category required	Backup server category Example : `BAREMETAL_SERVER`	string	None
query	server_name optional	Backup server name Example : `server-001`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupAgentTargetListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents/targets?server_category={server_category}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "server_backup_agent_ip": "11.22.33.44",
            "server_name": "server-001",
            "server_state": "RUNNING",
            "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
        }
    ],
    "count": 1
}

20.2 - 1.0

get /v1/backup-agents/targets

Description

List targets of Backup Agent.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	size optional	size Example : `20`	any of [integer, null]	20
query	page optional	page Example : `0`	any of [integer, null]	0
query	sort optional	Sort Example : `server_name:asc`	any of [string, null]	server_name:asc
query	server_category required	Backup server category Example : `BAREMETAL_SERVER`	string	None
query	server_name optional	Backup server name Example : `server-001`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupAgentTargetListResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents/targets?server_category={server_category}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "contents": [
        {
            "server_backup_agent_ip": "11.22.33.44",
            "server_name": "server-001",
            "server_state": "RUNNING",
            "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
        }
    ],
    "count": 1
}

21 - Manual Backup

21.1 - 1.1

post /v1/backups/{backup_id}/manual-backup

Description

Perform Manual Backup immediately.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/manual-backup

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

21.2 - 1.0

post /v1/backups/{backup_id}/manual-backup

Description

Perform Manual Backup immediately.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/manual-backup

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

22 - Restore Agent Backup

22.1 - 1.1

post /v1/backups/{backup_id}/restore-agent-backup

Description

Restore the Backup.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		AgentBackupRestoreRequest

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-agent-backup

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Request body

{
    "filesystem_paths": [
        {
            "destination": "/data",
            "source": "/data"
        }
    ],
    "overwrite": true,
    "restore_server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b"
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

22.2 - 1.0

post /v1/backups/{backup_id}/restore-agent-backup

Description

Restore the Backup.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		AgentBackupRestoreRequest

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/restore-agent-backup

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Request body

{
    "filesystem_paths": [
        {
            "destination": "/data",
            "source": "/data"
        }
    ],
    "overwrite": true,
    "restore_server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b"
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

23 - Restore Backup

23.1 - 1.1

post /v1/backups/{backup_id}/restore

Description

Restore the Backup.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		BackupRestoreRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/backups/{backup_id}/restore

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Request body

{
    "networks": [
        {
            "subnet_id": "023c57b14f11483689338d085e061492"
        }
    ],
    "restore_region": "kr-west1",
    "restore_server_name": "restoretest1",
    "restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b",
    "security_groups": [
        "023c57b14f11483689338d085e061492"
    ],
    "server_type_id": "s1v1m2"
}

Example HTTP response

Response 202

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

23.2 - 1.0

post /v1/backups/{backup_id}/restore

Description

Restore the Backup.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		BackupRestoreRequest

Responses

HTTP Code	Description	Schema
202	Accepted	AsyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None
409	Conflict	None

Example HTTP request

Request path

/v1/backups/{backup_id}/restore

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Request body

{
    "networks": [
        {
            "subnet_id": "023c57b14f11483689338d085e061492"
        }
    ],
    "restore_region": "kr-west1",
    "restore_server_name": "restoretest1",
    "restore_target_id": "ca1a8e76-af49-40ea-93f8-a5989ffe138b",
    "security_groups": [
        "023c57b14f11483689338d085e061492"
    ],
    "server_type_id": "s1v1m2"
}

Example HTTP response

Response 202

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

24 - Set Backup Schedule

24.1 - 1.1

put /v1/backups/{backup_id}/schedules

Description

Set Backup schedule.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		ModifyBackupSchedulesRequest

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/schedules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Request body

{
    "schedules": [
        {
            "frequency": "DAILY",
            "start_day": "MON",
            "start_time": "09:00:00",
            "start_week": "WEEK_2",
            "type": "FULL"
        }
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

24.2 - 1.0

put /v1/backups/{backup_id}/schedules

Description

Set Backup schedule.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		ModifyBackupSchedulesRequest

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/schedules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Request body

{
    "schedules": [
        {
            "frequency": "DAILY",
            "start_day": "MON",
            "start_time": "09:00:00",
            "start_week": "WEEK_2",
            "type": "FULL"
        }
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

25 - Set Filesystem Path

25.1 - 1.1

put /v1/backups/{backup_id}/filesystem-path

Description

Set Filesystem path.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		FileSystemPathUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/filesystem-path

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Request body

{
    "backup_filesystem_paths": [
        "/aaa",
        "/bbb"
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

25.2 - 1.0

put /v1/backups/{backup_id}/filesystem-path

Description

Set Filesystem path.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		FileSystemPathUpdateRequest

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/filesystem-path

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Request body

{
    "backup_filesystem_paths": [
        "/aaa",
        "/bbb"
    ]
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

26 - Show Backup

26.1 - 1.1

get /v1/backups/{backup_id}

Description

Show the detail of Backup.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

HTTP Code	Description	Schema
200	OK	BackupDetailResponse1Dot1
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "backup_agent_id": "BACKUP_AGENT-abcd",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "dr_enabled": false,
    "dr_region": "kr-west1",
    "encrypt_enabled": false,
    "filesystem_paths": [
        "/aaa",
        "/bbb"
    ],
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "backup-001",
    "origin_backup_id": "00cd2538fbf94d12b36aabbdd607e974",
    "policy_category": "AGENTLESS",
    "policy_type": "VM_IMAGE",
    "region": "kr-west1",
    "replica_backup_id": "00cd2538fbf94d12b36aabbdd607e974",
    "retention_period": "WEEK_2",
    "role_type": "ORIGINAL",
    "server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
    "server_name": "server-001",
    "server_os_type": "WINDOWS",
    "server_region": "kr-west1",
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "state": "AVAILABLE"
}

26.2 - 1.0

get /v1/backups/{backup_id}

Description

Show the detail of Backup.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None

Responses

HTTP Code	Description	Schema
200	OK	BackupDetailResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "backup_agent_id": "BACKUP_AGENT-abcd",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "encrypt_enabled": false,
    "filesystem_paths": [
        "/aaa",
        "/bbb"
    ],
    "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "backup-001",
    "policy_category": "AGENTLESS",
    "policy_type": "VM_IMAGE",
    "region": "kr-west1",
    "retention_period": "WEEK_2",
    "role_type": "ORIGINAL",
    "server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
    "server_name": "server-001",
    "server_os_type": "WINDOWS",
    "server_region": "kr-west1",
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "state": "AVAILABLE"
}

27 - Show Backup Agent

27.1 - 1.1

get /v1/backup-agents/{backup_agent_id}

Description

Show the detail of Backup Agent.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_agent_id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	string	None

Responses

HTTP Code	Description	Schema
200	OK	BackupAgentDetailResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents/{backup_agent_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
    "backup_master_ip": "33.44.55.66",
    "backup_master_name": "backupmastertest",
    "backup_policy_count": "3",
    "connection_check_time": "2024-11-11T09:13:48Z",
    "connection_state": "SUCCESS",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "id": "BACKUP_AGENT-abcd",
    "install_file_path": "http://linux-agent",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "agent_abcd12",
    "server_backup_agent_ip": "11.22.33.44",
    "server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
    "server_gateway_ip": "22.33.44.55",
    "server_name": "server-001",
    "server_os_type": "WINDOWS",
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "state": "AVAILABLE"
}

27.2 - 1.0

get /v1/backup-agents/{backup_agent_id}

Description

Show the detail of Backup Agent.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_agent_id required	Backup Agent ID Example : `BACKUP_AGENT-abcd`	string	None

Responses

HTTP Code	Description	Schema
200	OK	BackupAgentDetailResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents/{backup_agent_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "account_id": "fnsd89fus0f9ds09f90dshf9dshfds09",
    "backup_master_ip": "33.44.55.66",
    "backup_master_name": "backupmastertest",
    "backup_policy_count": "3",
    "connection_check_time": "2024-11-11T09:13:48Z",
    "connection_state": "SUCCESS",
    "created_at": "2024-05-17T00:23:17Z",
    "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "id": "BACKUP_AGENT-abcd",
    "install_file_path": "http://linux-agent",
    "modified_at": "2024-05-17T00:23:17Z",
    "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
    "name": "agent_abcd12",
    "server_backup_agent_ip": "11.22.33.44",
    "server_category": "VIRTUAL_SERVER | GPU_SERVER | BAREMETAL_SERVER",
    "server_gateway_ip": "22.33.44.55",
    "server_name": "server-001",
    "server_os_type": "WINDOWS",
    "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366",
    "state": "AVAILABLE"
}

28 - Show Backup Agent Install File Path

28.1 - 1.1

get /v1/backup-agents/agent-install-file-path

Description

Show Backup Agent Install File Path.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
query	os_type required	OS type Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	InstallFilePathResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents/agent-install-file-path?os_type={os_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "install_file_path": "http://linux-agent"
}

28.2 - 1.0

get /v1/backup-agents/agent-install-file-path

Description

Show Backup Agent Install File Path.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
query	os_type required	OS type Example :	string	None

Responses

HTTP Code	Description	Schema
200	OK	InstallFilePathResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backup-agents/agent-install-file-path?os_type={os_type}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Example HTTP response

Response 200

{
    "install_file_path": "http://linux-agent"
}

29 - Update Replication Use

29.1 - 1.1

put /v1/backups/{backup_id}/replication

Description

Update Replication use.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		BackupReplicationUseUpdateBody

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/replication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Request body

{
    "dr_enabled": false
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

29.2 - 1.0

put /v1/backups/{backup_id}/replication

Description

Update Replication use.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		BackupReplicationUseUpdateBody

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/replication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Request body

{
    "dr_enabled": false
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

30 - Update Retention Period

30.1 - 1.1

put /v1/backups/{backup_id}/retention-period

Description

Update the retention period.

State ACTIVE (CURRENT)

Version	Supported Until
1.1	-

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		RetentionPeriodUpdateBody

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/retention-period

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Request body

{
    "retention_period": "WEEK_2"
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}

30.2 - 1.0

put /v1/backups/{backup_id}/retention-period

Description

Update the retention period.

State ACTIVE (DEPRECATED)

Version	Supported Until
1.0	20260331

Parameters

Type	Name	Description	Schema	Default
path	backup_id required	Backup ID Example : `00cd2538fbf94d12b36aabbdd607e974`	string	None
body	body required		RetentionPeriodUpdateBody

Responses

HTTP Code	Description	Schema
200	OK	SyncResponse
401	Unauthorized	None
403	Forbidden	None
404	Not Found	None

Example HTTP request

Request path

/v1/backups/{backup_id}/retention-period

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.0"

Request body

{
    "retention_period": "WEEK_2"
}

Example HTTP response

Response 200

{
    "request_id": "",
    "resource": {
        "id": "",
        "links": [
            ""
        ]
    }
}