Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Refs/ Obtaining the Tag List
Updated on 2026-04-28 GMT+08:00
View PDF

Obtaining the Tag List

Function

This API is used to obtain the tag list.

Debugging

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

URI

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

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

creator

No

String

Definition

Creator, which can be a user ID or IAM ID.

Range

1–100,000 characters.

sort

No

String

Definition

Sorting method.

Constraints

  • asc: ascending order.

  • desc: descending order.

Default value:

desc

Enumeration values:

  • asc

  • desc

search

No

String

Definition

Search criterion, which is the label name.

Range

1–2,000 characters.

Value range:

1~2000

order_by

No

String

Definition

Sorting method.

Range

  • name: indicates name.

  • created: creation time.

  • updated: update time.

Default value:

updated

Enumeration values:

  • name

  • updated

  • created

view

No

String

Definition

Content to be displayed in the result set.

Range

  • detail: returns all label information.

  • basic: returns basic label information.

  • simple: returns simple label information.

Enumeration values:

  • simple

  • basic

  • detail

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 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.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Total

String

Obtain the tag list.
Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of SimpleTagDto objects

Tag list.
Table 6 SimpleTagDto

Parameter

Type

Description

name

String

Label name

message

String

Label description

target

String

Target commit_id

gpgKey

GpgKeyDto object

GPG information

can_delete

Boolean

Can be deleted or not

can_read

Boolean

Can be checked or not

can_download

Boolean

Can be downloaded or not
Table 7 GpgKeyDto

Parameter

Type

Description

gpg_name

String

GPG name

open_gpg_verified

Boolean

Whether to enable GPG authentication

verification_status

Integer

GPG authentication status

gpg_primary_key_id

String

GPG initialization ID

gpg_nick_name

String

GPG alias

gpg_tenant_name

String

GPG tenant alias

gpg_user_name

String

GPG username

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 404

Table 10 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/tags

Example Responses

Status code: 200

Obtain the tag list.

{
  "name" : "master",
  "default" : true,
  "target" : "******",
  "gpgKey" : null,
  "can_delete" : null,
  "can_read" : null,
  "can_download" : null
}

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

Obtain the tag list.

401

Unauthorized

403

Bad Request

404

Not Found

Error Codes

See Error Codes.

Parent topic: Refs