Help Center/ KooDrive/ API Reference（Carrier）/ API/ Backup Scopes/ List Backup Scopes
Updated on 2026-04-16 GMT+08:00
View PDF
Share

List Backup Scopes

Function

List backup scopes.

URI

GET /koodrive/ose/v1/backup/device/{deviceId}/scope

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

deviceId

Yes

String

Definition:

Device ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

moduleCode

Yes

String

Definition:

Module code.

Constraints:

100–102

Range:

100: folder backup 101: album backup 102: address book backup

Default Value:

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

This field stores the access token.

Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission.

Constraints:

The format is bearer+access token.

Range:

For details about how to obtain an access token, see the corresponding developer guide.

Default Value:

N/A

X-User-Id

Yes

String

Definition:

User ID on KooDrive, which is used for app ID authentication.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Date

Yes

String

Definition:

Signature time, which is used for app ID authentication.

Constraints:

The value must be within 15 minutes from the current time and cannot be later than the current time.

Range:

The format is yyyMMdd'T'HHmmss'Z', for example, 20251103T070140Z.

Default Value:

N/A

Definition:

Signature time, which is used for app ID authentication.

Constraints:

The value must be within 15 minutes from the current time and cannot be later than the current time.

Range:

The format is yyyMMdd'T'HHmmss'Z', for example, 20251103T070140Z.

Default Value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

Integer

Status code.

msg

String

Status description.

scopeList

Array of ScopeInfo objects

Backup data information list.
Table 5 ScopeInfo

Parameter

Type

Description

localPath

String

Local path.

targetFolderPath

String

Target folder on the cloud.

scopeId

String

Scope ID.

moduleCode

String

Module code.

createTime

String

Creation time.

Example Requests

Request example for listing backup scopes.

/koodrive/ose/v1/backup/device/1842812272691451648/scope

Authorization:Bearer+60f4ccc7b1********3dd9a68068

Example Responses

Status code: 200

Response body for listing backup scopes.

{
  "scopeList" : [ {
    "localPath" : "/asdkhsdahjksd",
    "targetFolderPath" : "/ashdjkha",
    "scopeId" : "1842846715527366528",
    "moduleCode" : "102",
    "createTime" : "2025-12-17T07:27:27.709Z"
  } ],
  "code" : 0,
  "msg" : "success"
}

Status Codes

Status Code

Description

200

Response body for listing backup scopes.
Parent topic: Backup Scopes