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

Viewing the Branch/Tag List

Function

This API is used to view the branch/tag 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/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

Default Value

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

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 body parameters

Parameter

Type

Description

[items]

Array of strings

Branch/tag list

Example Requests

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

Example Responses

Status code: 200

The repository branch/tag list was obtained successfully.

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

Status Codes

Status Code

Description

200

The repository branch/tag list was obtained successfully.

Error Codes

See Error Codes.

Parent topic: Refs