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

Return to the regular view of this page.

List Targets of Backup Agent

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

1 - 1.3

get /v1/backup-agents/targets

Description

List targets of Backup Agent.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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
query	zone optional	Availability zone name Example : `kr-west1-a`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	BackupAgentTargetListResponse1Dot2
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.3"

Example HTTP response

Response 200

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

2 - 1.2

get /v1/backup-agents/targets

Description

List targets of Backup Agent.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261231

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	BackupAgentTargetListResponse1Dot2
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.2"

Example HTTP response

Response 200

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

3 - 1.1

get /v1/backup-agents/targets

Description

List targets of Backup Agent.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.1	20260531

Parameters

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
}

4 - 1.0

get /v1/backup-agents/targets

Description

List targets of Backup Agent.

State ACTIVE (DEPRECATED)

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

Version	Not Before
1.0	20260331

Parameters

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
}