Updated on 2026-01-08 GMT+08:00

Creating a Protected Tag

Description

This API is used to create a protectd tag.

URI

POST /v2/repositories/{repository_id}/protected-tags

Table 1 Path parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Repository primary key ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Protected tag name

create_access_level

No

Integer

Permission to create a protected tag

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

error

Error object

Response error

result

AddProtectTagResponse object

Response result

status

String

Response status

Table 5 Error

Parameter

Type

Description

code

String

Error codes

message

String

Error message

Table 6 AddProtectTagResponse

Parameter

Type

Description

name

String

Protected tag name

create_access_levels

CreateAccessLevels object

Permission to create a protected tag

Table 7 CreateAccessLevels

Parameter

Type

Description

access_level

Integer

Permission

access_level_description

String

Permission description

Request Examples

POST https://{endpoint}/v2/repositories/{repository_id}/protected_tags

{
  "name" : "test",
  "create_access_level" : 40
}

Response Examples

Status code: 200

Request succeeded

{
  "result" : {
    "name" : "test",
    "create_access_levels" : {
      "access_level" : 40,
      "access_level_description" : "Maintainers"
    }
  },
  "status" : "success"
}

Status Codes

Status Codes

Description

200

Request succeeded

Error codes

See Error Codes.