Updated on 2023-09-12 GMT+08:00

API Overview

SSH Key

API

Description

Obtaining the SSH Key List

Obtain the SSH key list.

Adding an SSH Key

Add an SSH key.

Check whether the private key has the permission to pull code.

Check whether a private key has the permission to pull code.

Repository

API

Description

Obtain files in the branch directory.

Obtain files in the branch directory.

Obtaining Warehouse Statistics

Obtain repository statistics.

Obtains image files of a specific branch in a repository.

Obtain image files of a specific branch in a repository.

Modifying the Status of a Repository Referenced by a Pipeline

Modify the status of a repository referenced by a pipeline.

Checks whether a user has the warehouse administrator permission.

Check whether a user has the repository administrator permission.

Sets whether a repository is in public or private state.

Indicate whether a repository is public or private.

Obtains the content of a specified file in a specified branch of a repository.

Obtain the content of a specified file in a specified branch of a repository.

Obtaining the List of Public Sample Templates

Obtain the list of public sample templates.

Creating a repository

Create a repository on a specified project with the specified name. Input parameters include the repository name, template ID, whether to import project members, and home project.

Obtain the short ID of the repository based on the repository name and group name to combine the short ID with the URL of the submission details page corresponding to commitid.

Obtain the short ID of a repository, which is used to obtain the URL of the repository details page.

Queries the submission of a branch of a repository based on the group name and repository name.

Obtain the commit list by repository group name, repository name, and branch.

Querying the Branch of a Warehouse

Obtain the branch list of a specified repository based on the repository ID.

This API is used to query the submission of a branch of a warehouse based on the warehouse ID. More optional parameters are provided.

Query the commit of a repository branch based on the repository ID.

Adding a Deployment Key

Add a deployment key.

Deleting a Repository Deployment Key

Delete the repository deployment key.

Obtains the last submission statistics of the warehouse.

Obtain the last commit statistics of the repository.

Repository Statistics

Query code commit record statistics of a repository based on the repository short ID.

Delete repositories

Delete a repository based on the 32-bit UUID of the repository.

Check the repository creation status.

Obtain the repository status.

Querying the Tag List of a Warehouse

Query the branch corresponding to a specified repository.

Adding a Tag

Create a tag.

Querying the Details of a Warehouse

Obtain repository information based on the repository UUID. The returned information contains the ID, name, group name, and repository access URL.

Obtains the number of submitted code lines.

Obtain the number of committed code lines of a specified branch in the code repository on a specified date.

Download Repository

Download a repository in the specified format.

Creating a Protection Branch

Create a protection branch.

Obtaining the Repository Branch List

Obtain the repository branch list.

Obtaining the List of Warehouse Combination Requests

Obtain the repository MR list.

Obtaining Warehouse Combination Request Details

Obtain details about a repository MR.

V2Project

API

Description

Querying All Warehouses of a User

Obtain information about all repositories of a user.

Create projects and repositories.

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.

Creating a Project and Forking a Repository

After a repository is created, parameters transferred to the fork repository include the repository name, whether to import project members, and home project.

Querying All Warehouses in a Project

Obtain the repository list. Fuzzy query is supported: If the project UUID is not specified, fuzzy query by repository name or project name is supported; otherwise, fuzzy query by repository name is supported.

Associating Branches with Work Items

Associate a branch with a work item.

RepoMenber

API

Description

Obtains all member records in a warehouse.

Obtain the repository member list. You can search for a member by keyword.

Add repository members

The calling party codehubportal adds a repository member.

Sets the role of a member in the warehouse.

Assign repository operation permissions to repository members.

Delete repository members

Delete repository members

Commit

API

Description

Querying the Submission Information of a Warehouse

Obtain commit information based on the repository short ID. The list of all commits in the path can be queried based on the file path.

Creating a Commit

Multiple files in different directories can be submitted at a time. If the directory does not exist, the system automatically creates a directory. The forcible overwrite option is supported. When the forcible overwrite flag is set to true, the conflict is ignored and the configuration is forcibly submitted.

Querying Specific Submission Information of a Warehouse

Obtain a specific commit by commit ID, branch name, or tag name.

Querying the Submission Discrepancy Information of a Warehouse

Query commit difference information by commit ID.

File

API

Description

Querying File Information of a Warehouse

Obtain information about files in the repository, such as the name, size, and content. Note that the file content is encoded using Base64.

User

API

Description

HTTPS account and password verification

Check whether the username and password entered when you upload or download code using HTTPS are valid.

Webhook

API

Description

Querying the Webhook of a Specified Warehouse

Obtain the repository webhook.

Adding a Hook to a Specified Repository

A code commit automatically triggers building and addition of a repository hook.

Deletes the hook of a specified repository.

A code commit automatically triggers building and deletion of a repository hook.

Project

API

Description

Obtains the list of repositories that can be set to the public state in a project.

Obtain the list of repositories that can be set to the public state under a project.

Verifying the Repository Name of a Specified Project

This API is called when a repository is created. The project UUID and repository name are transferred, and the CoudeHubAdapter API is called to query the database to check whether the repository name is duplicate.

V2 Repository Management

API

Description

Create branches

Create a branch in a specified repository based on the repository ID.

Discussion

API

Description

Create MR Review Comments

Create MR review comments.

Reply to MR review comments.

Reply to MR review comments.

Setting for Obtaining Review Comments

Obtain review comments.