Obtaining the List of All Files in a Specified Branch

This API is used to obtain the list of all files in a specified branch.

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

GET https://{hostURL}/v4/repositories/{repository_id}/repository/file-list

**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. Value range: 1~2147483647

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
ref_name	No	String	Definition: Branch or tag name. Constraints: Do not start with hyphen (-), period (.) refs, heads, refs, or remotes. Do not end with . / .lock. Spaces and the following characters are not supported: [ \ < ~ ^ : ? * ! ( ) ' " \| Value range: 1 to 200 characters. Default value: Default branch of the repository.
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

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. Range 1–100,000 characters. Default Value N/A.

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-Total	String	Definition Total number of files.

**Table 5** Response body parameters
Parameter	Type	Description
[items]	Array of strings	File list.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

GET https://{endpoint}/v4/repositories/2112029050/repository/file-list

Status code: 200

File list.

[ "d", "123" ]

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

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

Parent topic: File

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.