Help Center/ KooDrive/ API Reference（Carrier）/ API/ Backup Record/ Creating a Backup Record
Updated on 2026-02-12 GMT+08:00
View PDF
Share

Creating a Backup Record

Function

Create a backup record.

URI

POST /koodrive/ose/v1/backup/record

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

x-backup-lock-id

Yes

String

Definition:

Lock 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
Table 2 Request body 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

deviceId

Yes

String

Definition:

Device ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

properties

No

String

Definition:

Custom property.

Constraints:

JSON format.

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

Integer

Status code.

msg

String

Status description.

data

BackupRecord object

Backup record.
Table 4 BackupRecord

Parameter

Type

Description

recordId

String

Record ID.

moduleCode

String

Module code.

status

Integer

Status Value:

  • 0: new.

  • 1: completed.

  • 2: to be deleted.

properties

String

Custom property.

version

Integer

Version.

createTime

String

Creation time.

endTime

String

End time.

deviceInfo

DeviceEntity object

Device information.
Table 5 DeviceEntity

Parameter

Type

Description

deviceId

String

Device ID.

machineCode

String

Machine code.

deviceName

String

Device name.

deviceOS

String

Device system.

createTime

String

Creation time.

Example Requests

Request example for creating a backup record.

/koodrive/ose/v1/backup/record

Authorization:Bearer+60f4ccc7b1********3dd9a68068
x-backup-lock-id: 78e41c7e-db02-4d55-85b3-8153e4fefd2e@102
{
    "moduleCode": "101",
    "deviceId": 1842812272691451648,
    "properties": "{\"test\":\"123\"}"
}

Example Responses

Status code: 200

Response body for creating a backup record.

{
  "data" : {
    "recordId" : "1842862763295184641",
    "moduleCode" : "101",
    "status" : 0,
    "properties" : "{\"test\":\"123\"}",
    "version" : 1,
    "createTime" : "2025-12-17T07:59:20.752Z"
  },
  "code" : 0,
  "msg" : "success"
}

Status Codes

Status Code

Description

200

Response body for creating a backup record.
Parent topic: Backup Record