Help Center/KooDrive/API Reference（Carrier）/API/File Favorites/Adding Files to Favorites
Updated on 2026-02-12 GMT+08:00
View PDF
Share

Adding Files to Favorites

Function

Add files to favorites or remove files from favorites. Up to 100 files are supported.

URI

POST /koodrive/ose/v1/star/batch

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

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. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Traceid

No

String

Definition:

Service trace ID, which contains 58 bits.

Constraints:

N/A

Range:

The value contains 58 bits.

Default Value:

N/A

language

No

String

Definition:

Language code.

Constraints:

The value must comply with the internationalization specifications. For example, en_us indicates English (United States).

Range:

The value must comply with the internationalization specifications.

Default Value:

en-US

X-User-Id

Yes

String

Definition:

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

Constraints:

N/A

Range:

N/A

Default Value:

N/A

X-Date

Yes

String

Definition:

Date, which is used for app authentication. The format is yyyyMMdd'T'HHmmss'Z'.

Constraints:

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

Range:

N/A

Default Value:

N/A

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

starred

Yes

Boolean

Definition:

Favorited or not.

Constraints:

N/A

Range:

true,false

Default Value:

N/A

subRequestList

Yes

Array of StarFileRequest objects

Files to be added to favorites.

Definition: File list.

Constraints: The list length is less than or equal to 100.

Range: N/A

Default Value: N/A

Table 3 StarFileRequest

Parameter

Mandatory

Type

Description

containerId

Yes

String

Space ID.

Definition: Space ID.

Constraints: N/A

Range: N/A

Default Value: N/A

fileId

Yes

String

File ID, which must be unique.

Definition: File ID.

Constraints: N/A

Range: N/A

Default Value: N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

Integer

Response status. 0: all successful; 1: partially successful; 2: all failed.

subResponseList

Array of SubResponse objects

Sub-response list.

code

String

Response code.

msg

String

Response information.

Table 5 SubResponse

Parameter

Type

Description

fileId

String

File ID.

code

String

Response code.

message

String

Response information.

Example Requests

{
  "starred" : true,
  "subRequestList" : [ {
    "containerId" : "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4",
    "fileId" : "Fn1bTLIOomJkTCAe9DEVBRY4U6IkuqkMZ"
  } ]
}

Example Responses

Status code: 200

OK

{
  "status" : 0,
  "subResponseList" : [ {
    "fileId" : "Fn1bTLIOomJkTCAe9DEVBRY4U6IkuqkMZ",
    "code" : "0",
    "message" : "success"
  } ]
}

Status Codes

Status Code

Description

200

OK

Parent topic:File Favorites