Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Repository/ Checking Repository Names in Batches

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

View PDF

Checking Repository Names in Batches

Function

This API is used to check repository names in batches.

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

POST https://{hostURL}/v4/repository-names/validations

Request Parameters

**Table 1** 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

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	Definition: Repository name Constraints: Mandatory Start with a letter, digit, or underscore (), and use letters, digits, hyphens (-), underscores (), and periods (.). Do not end with .git, .atom, or a period (.). The repository path (including the repository group name and repository name) cannot exceed 256 characters. Value range: N/A Default value: N/A
project_id	No	String	Definition: Project ID Constraints: Mandatory Value range: N/A Default value: N/A
group_id	No	Integer	Definition: Repository group ID. If the repository name to be checked is in the project root directory, this parameter is not required. Constraints: N/A Value range: N/A Default value: 1-2147483647 Value range: 1~2147483647

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
[items]	Array of ValidateRepoNameResultDto objects	Check result

**Table 4** ValidateRepoNameResultDto
Parameter	Type	Description
name	String	Definition: Repository name Constraints: Mandatory Start with a letter, digit, or underscore (), and use letters, digits, hyphens (-), underscores (), and periods (.). Do not end with .git, .atom, or a period (.). The repository path (including the repository group name and repository name) cannot exceed 256 characters. Value range: N/A Default value: N/A
project_id	String	Definition: Project ID Constraints: Mandatory Value range: N/A Default value: N/A
group_id	Integer	Definition: Repository group ID. If the repository name to be checked is in the project root directory, this parameter is not required. Constraints: N/A Value range: N/A Default value: 1-2147483647 Value range: 1~2147483647
result	Boolean	Definition: Whether the verification is passed. Value range: true: yes false: no Constraints: N/A
error_message	String	Definition: Error information Constraints: N/A

Example Requests

Check repository names in batches.

POST /api/v4/repository-names/validations

[ {
  "name" : "ff123",
  "group_id" : null,
  "project_id" : "7efec10fa1704f07aa118ea3d5a93413"
}, {
  "name" : "r1",
  "group_id" : null,
  "project_id" : "7efec10fa1704f07aa118ea3d5a93413"
}, {
  "name" : "fff",
  "group_id" : 2111926488,
  "project_id" : "7efec10fa1704f07aa118ea3d5a93413"
} ]

Example Responses

Status code: 200

Batch check result

[ {
  "name" : "ff123",
  "project_id" : "7efec10fa1704f07aa118ea3d5a93413",
  "group_id" : null,
  "result" : true,
  "error_message" : null
}, {
  "name" : "r1",
  "project_id" : "7efec10fa1704f07aa118ea3d5a93413",
  "group_id" : null,
  "result" : false,
  "error_message" : "Repository or repository group with the same name already exists."
}, {
  "name" : "fff",
  "project_id" : "7efec10fa1704f07aa118ea3d5a93413",
  "group_id" : 2111926488,
  "result" : false,
  "error_message" : "Repository or repository group with the same name already exists."
} ]