Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Obtaining the Repository ID Based on the Repository Name and Group Name
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the Repository ID Based on the Repository Name and Group Name

Function

This API is used to obtain the repository ID. The repository ID can be used to obtain the repository web URL.

URI

GET /v1/repositories/repoid

Table 1 Query parameters

Parameter

Mandatory

Type

Description

group_name

Yes

String

Explanation

Repository group name (the segment between the domain name and repository name in a clone address).

Example: git@repo.example.com:Demo00228/testword.git. Demo00228 is the group name.

Constraints

None

Range

The value is a string of 1 to 2,000 characters.

Default value

None

repository_name

Yes

String

Explanation

Repository name

Constraints

None

Range

The value is a string of 1 to 2,000 characters.

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

Range

None

result

Integer

Explanation

Repository ID.

Range

None

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/repositories/repoid

Example Responses

Status code: 200

OK

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

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Repository