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

Return to the regular view of this page.

List Backup Restore Targets

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

1 - 1.3

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

Description

List Backup restore targets.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

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.3"

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
}

2 - 1.2

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

Description

List Backup restore targets.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20261231

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

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
}

3 - 1.1

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

Description

List Backup restore 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
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
}

4 - 1.0

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

Description

List Backup restore 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
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
}