Viewing the Branch/Tag List

This API is used to view the branch/tag list.

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/refs

**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
type	No	String	Definition: Branch or tag. Value range: The value can only be branch or tag. Constraints: The value can only be branch or tag. Default value: branch Enumeration values: branch tag
search	No	String	Definition: Search keyword.
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 body parameters
Parameter	Type	Description
[items]	Array of strings	Branch/tag list

GET https://{endpoint}/v4/repositories/{repository_id}/repository/refs?type=branch&ref=master&search=abc

Status code: 200

The repository branch/tag list was obtained successfully.

[ "a", "b", "c" ]

Status Code	Description
200	The repository branch/tag list was obtained successfully.

Parent topic: Ref

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

The system is busy. Please try again later.