Adding Backup Scopes

deviceId

Yes

String

Definition:

Device ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

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

moduleCode

Yes

String

Definition:

Module code.

Constraints:

100–102

Range:

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

Default Value:

N/A

scopeList

Yes

Array of ScopeBaseInfo objects

Definition:

Scope list.

Constraints:

The maximum length is 100.

Range:

N/A

Default Value:

N/A

localPath

No

String

Definition:

Local path. Use a slash (/) as the path separator. The value must start with a slash (/). This parameter and targetFolderPath cannot be empty at the same time.

Constraints:

^(?:$|/[^\]*$)

Range:

The maximum length is 10,000.

Default Value:

N/A

targetFolderPath

No

String

Definition:

Target cloud folder. Use a slash (/) as the path separator. The value must start with a slash (/). This parameter and targetFolderPath cannot be empty at the same time.

Constraints:

^(?:$|/[^\]*$)

Range:

The maximum length is 10,000.

Default Value:

N/A

code

Integer

Status code.

msg

String

Status description.

scopeList

Array of ScopeInfo objects

Scope information that is successfully added.

failedScopeList

Array of ScopeAddFailedInfo objects

Scope information that fails to be added.

localPath

String

Local path.

targetFolderPath

String

Target folder on the cloud.

scopeId

String

Scope ID.

moduleCode

String

Module code.

createTime

String

Creation time.

localPath

String

Local path.

targetFolderPath

String

Target folder on the cloud.

errorCode

String

Error code.

msg

String

Error message.

200

Response body for adding backup scopes of modules in batches.