Help Center/ CodeArts Repo/ API Reference/ APIs/ Project/ Verifying a Repository Name of a Specified Project
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Verifying a Repository Name of a Specified Project

Function

This API is used to check whether the repo name exists in the project and is usually invoked for verification before a repo is created.

URI

GET /v1/projects/{project_uuid}/repositories/validation/{repository_name}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_uuid

Yes

String

Explanation:

Project ID. For details, see Obtaining a Project ID. Constraints

None.

Range

32 digits and letters.

Default value

None.

repository_name

Yes

String

Explanation:

Repository name.

Constraints

None.

Range

None.

Default value

None.

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation

User token. It can be obtained by calling the corresponding IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints

None.

Range

1–100,000 characters.

Default value

None.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error

Error object

Explanation

Response error.

Range

None

result

Boolean

Explanation

Check whether the repo exists.

Range

  • true: The repo does not exist and the name is available.
  • false: The repo exists, and the name cannot be used.

status

String

Explanation

Response status.

Range

  • success: The API call is successful.
  • failed: The API call failed.
Table 4 Error

Parameter

Type

Description

code

String

Explanation:

Error code.

Range

Max. 100 characters in the error code format.

message

String

Explanation:

Error Message

Range

None

Example Requests

GET https://{endpoint}/v1/projects/{project_uuid}/repositories/validation/{repository_name}

Example Responses

Status code: 200

OK

{
  "result" : true,
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Project