Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Group/ Creating a Repository Group
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Creating a Repository Group

Function

This API is used to create a repository group.

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:group:createGroup

Write

-

-

-

-

URI

POST https://{hostURL}/v4/{project_id}/groups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

You can obtain the unique project identifier, 32-character project UUID, by calling the API used to query the project list.

Range

String length: 32 characters.

Request Parameters

Table 2 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 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Repository group name

parent_id

No

Integer

Parent repository group ID. If this parameter is left blank, a repository group is created under the project by default.

Value range:

1~2147483647

visibility

No

String

Visibility. The value can be private or public

Default value:

public

Enumeration values:

  • public

  • private

description

No

String

Description

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

description

String

Repository group description

full_name

AnyType

Repository group full name

id

Integer

Repository group ID

Value range:

1~2147483647

name

String

Error code

visibility

String

Visibility. The value can be private or public

Default value:

public

Enumeration values:

  • public

  • private

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

/v4/0b234373cf3f4b04ab2d8a245155e12b/groups

{
  "name" : "TG2",
  "description" : "",
  "visibility" : "private"
}

Example Responses

Status code: 201

OK

{
  "description" : "groupDescription",
  "full_name" : "41bcec7bf2c84efea690e987ca98ee40 / g22-8",
  "id" : 2111667253,
  "name" : "groupName",
  "visibility" : "private"
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code

Description

201

OK

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.

Parent topic: Group