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

Listing Backup Files

Function

List backup files.

URI

GET /koodrive/ose/v1/backup/record/{recordId}/files

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

recordId

Yes

String

Definition:

Backup record ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

pageSize

Yes

Integer

Definition:

Page size.

Constraints:

N/A

Range:

1–100

Default Value:

N/A

cursor

No

String

Definition:

Cursor.

Constraints:

N/A

Range:

The maximum length is 1,000.

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.

data

Array of BackupFile objects

Backup file information list.

nextCursor

String

Next page cursor.
Table 5 BackupFile

Parameter

Type

Description

fileId

String

File ID.

fileName

String

File name.

sha256

String

File fingerprint.

size

Long

File size, in bytes.

description

String

Description.

createTime

String

Creation time.

Example Requests

Request example for listing backup files.

/koodrive/ose/v1/backup/record/1842862763295184641/files?pageSize=1

Authorization:Bearer+60f4ccc7b1********3dd9a68068
x-backup-lock-id: 78e41c7e-db02-4d55-85b3-8153e4fefd2e@102

Example Responses

Status code: 200

Response body for listing backup files.

{
  "data" : [ {
    "fileId" : "FuxCm9nVttfaIdohnfs1BB6hNdU2w7bX2",
    "fileName" : "123.jpg",
    "sha256" : "5b7be4c0c1b6f6a4107f2b8d40661c9c06c50fa9d2b7ba0c439a386cd18c3c33",
    "size" : "2139005",
    "createTime" : "2025-12-18T01:22:58.738Z"
  } ],
  "code" : 0,
  "msg" : "Success."
}

Status Codes

Status Code

Description

200

Response body for listing backup files.
Parent topic: Backup Record