Help Center/ CodeArts Repo/ API Reference/ APIs/ Project/ Verifying a Repository Name of a Specified Project
Updated on 2025-03-28 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

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

repository_name

Yes

String

Repository name.

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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error

Error object

Response error.

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

Response status.
Table 4 Error

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

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