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

Return to the regular view of this page.

List Backup Targets

1: 1.3
2: 1.2
3: 1.1
4: 1.0

1 - 1.3

get /v1/backups/backup-targets

Description

List Backup targets.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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
query	policy_type required	Backup policy type Example : `VM_IMAGE`	enum (VM_IMAGE, FILESYSTEM, FILE_STORAGE)	None
query	zone optional	Availability zone name Example : `kr-west1-a`	any of [string, null]	None

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}&policy_type={policy_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.3"

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
}

2 - 1.2

get /v1/backups/backup-targets

Description

List Backup targets.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261231

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
query	policy_type required	Backup policy type Example : `VM_IMAGE`	enum (VM_IMAGE, FILESYSTEM, FILE_STORAGE)	None

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}&policy_type={policy_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.2"

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
}

3 - 1.1

get /v1/backups/backup-targets

Description

List Backup targets.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260531

Parameters

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
}

4 - 1.0

get /v1/backups/backup-targets

Description

List Backup targets.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260331

Parameters

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
}