Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ File/ Viewing the Branch File List
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Viewing the Branch File List

Function

This API is used to view the branch file list.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo:repository:getRepository

Read

-

-

-

-

URI

GET https://{hostURL}/v4/repositories/{repository_id}/repository/trees

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Definition

You can query the project list to obtain the repository ID by calling the API used to query user's all repositories.

Constraints

N/A

Default Value

N/A

Value range:

1~2147483647
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

ref

No

String

Definition

Reference, which can be a branch name, label name, or commit ID. If this parameter is not transferred, the default branch is used.

Range

1–2,000 characters.

path

No

String

Definition

File path.

Range

1–100,000 characters.

recursive

No

Boolean

Definition

Whether to use recursive query.

Default value:

false

offset

No

Integer

Definition

Offset, which starts from 0.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Definition

Number of returned records.

Value range:

1~100

Default value:

20

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Total

String

View the branch file list.
Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of TreeObjectDto objects

File list.
Table 6 TreeObjectDto

Parameter

Type

Description

id

String

Unique file identifier.

name

String

File name

type

String

Object type

path

String

File path

mode

String

Mode structure

submodule_link

String

Submodule link

submodule_branch

String

Submodule branch

md5

String

MD5 value

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/repositories/2112015538/repository/trees

Example Responses

Status code: 200

View the branch file list.

[ {
  "id" : "*****",
  "name" : "images",
  "type" : "tree",
  "path" : "images",
  "mode" : "040000",
  "submodule_link" : null,
  "submodule_branch" : null,
  "md5" : "59b514174bffe4ae402b3d63aad79fe0"
} ]

Status code: 401

Unauthorized

{
  "error_code" : "CH.00000001",
  "error_msg" : "User authentication info not found."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.00401008",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status code: 404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "The repository does not exist. Check and try again."
}

Status Codes

Status Code

Description

200

View the branch file list.

401

Unauthorized

403

Bad Request

404

Not Found

Error Codes

See Error Codes.

Parent topic: File