Help Center/CodeArts Repo/API Reference/APIs/Project (V2)/Creating a Project and Repository
Updated on 2025-05-15 GMT+08:00
View PDF

Creating a Project and Repository

Function

After a project is created, the parameters for creating a repository group are generated in the background, including the repository name, template ID, whether to import project members, and home project.

URI

POST /v2/projects/repositories

Request Parameters

Table 1 Request header parameters

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:

Mandatory

Range:

1–100,000 characters.

Default value:

None

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

import_members

No

Integer

Explanation:

Whether to import project members.

Constraints:

None

Range:

  • 0: No
  • 1: Yes

Default value:

0

project_name

Yes

String

Explanation:

Project name.

Constraints:

Mandatory

Range:

Start with a letter and use only letters, digits, hyphens (-), and underscores (_).

Default value:

None

repo_name

Yes

String

Explanation:

Repository name.

Constraints:

Mandatory

Range:

  • Start with a letter, digit, or underscore (_), and use letters, digits, hyphens (-), underscores (_), and periods (.). Do not end with .git, .atom, or a period (.).
  • 1–256 characters.

Default value:

0

type

No

String

Explanation:

Project type, such as scrum.

Constraints:

None

Range:

Default value:

0

visibility_level

No

Integer

Explanation:

Repository visibility.

Constraints:

None

Range:

  • Private: Only repository members can read, write, and access the repository. Value: 0.
  • Public:
    1. For project members: Project members can view and search for the repository in the repository list of the project and repository group. Value: 10.
    2. For tenant members: Tenant members can view and search for the repository in the repository list of the project and repository group. Value: 10.
    3. For all visitors: All visitors can view and search for the repository in the repository list of the project and repository group. Value: 20.

Default value:

0

external_project_info

No

ExternalKeyMessage object

Explanation:

Third-party service information.

Constraints:

None

Table 3 ExternalKeyMessage

Parameter

Mandatory

Type

Description

external_key_message

No

String

Explanation:

Key information stored by third parties in CodeArts Repo.

Constraints:

None

Range:

Character string.

Default value:

None

external_service

No

String

Explanation:

External service name.

Constraints:

None

Range:

Character string.

Default value:

None

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

error

Error object

Explanation:

Response error.

result

ProjectRepository object

Explanation:

Response result.

status

String

Explanation:

Response status.

Range:

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

Parameter

Type

Description

code

String

Explanation:

Error code.

Range:

See Error Codes.

message

String

Explanation:

Error message.

Range:

Character string.

Table 6 ProjectRepository

Parameter

Type

Description

projectUuid

String

Explanation:

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

Range:

32 characters.

repositoryUuid

String

Explanation:

Repository UUID.

Range:

32 characters.

Example Requests

POST https://{endpoint}/v2/projects/repositories

{
  "project_name" : "testworld",
  "repo_name" : "demotest1",
  "import_members" : "0",
  "visibility_level" : "20",
  "type" : "normal"
}

Example Responses

Status code: 200

OK

{
  "result" : {
    "repositoryUuid" : "02637c34ba954ab5bd37ff9537fe05b4",
    "projectUuid" : "1aeda7a6070d4119b7d8b45e5641599b"
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic:Project (V2)