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

Creating a Backup Lock

Function

Create a backup lock with an expiration time of 10 minutes.

URI

POST /koodrive/ose/v1/backup/lock

Request Parameters

Table 1 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 2 Response body parameters

Parameter

Type

Description

code

Integer

Status code.

msg

String

Status description.

data

LockInfo object

The lock information.
Table 3 LockInfo

Parameter

Type

Description

lockId

String

Lock ID.

Example Requests

Request example for creating a backup lock.

/koodrive/ose/v1/backup/lock

Authorization:Bearer+60f4ccc7b1********3dd9a68068
{
  "moduleCode": "102"
}

Example Responses

Status code: 200

Response body for creating a backup lock.

{
  "data" : {
    "lockId" : "78e41c7e-db02-4d55-85b3-8153e4fefd2e@102"
  },
  "code" : 0,
  "msg" : "success"
}

Status Codes

Status Code

Description

200

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