Updated on 2025-01-14 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.

Checking Whether a Private Key Can Be Used to Pull Code

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

Repository

API

Description

Obtaining Files in a Branch Directory

Obtain files in the branch directory.

Obtaining Repository Statistics

Obtain repository statistics.

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

Checking Whether a User Has the Repository Administrator Permission

Check whether a user has the repository administrator permission.

Setting a Repository to Public or Private

Indicate whether a repository is public or private.

Obtaining the Content of a Specified File in a Repository Branch

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

Obtaining a Public Template List

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.

Obtaining a Repository Short ID to Generate the Details Page URL

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

Querying a Commit of a Branch by Repository or Repository Group Name

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

Querying Branches of a Specified Repository

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

Querying a Commit of a Repository Branch by the Repository ID

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

Adding a Deploy Key

Add a deployment key.

Deleting a Deploy Key

Delete the repository deployment key.

Obtaining the Last Commit Statistics of a Repository

Obtain the last commit statistics of the repository.

Repository Statistics

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

Deleting a Repository

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

Viewing a Repository Creation Status

Obtain the repository status.

Querying the Tag List of a Repository

Query the branch corresponding to a specified repository.

Adding a Tag

Create a tag.

Querying Details About a Repository.

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

Obtaining the Number of Committed Code Lines

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

Downloading a Repository

Download a repository in the specified format.

Creating a Protected Branch

Create a protection branch.

Obtaining a Repository Branch List

Obtain the repository branch list.

Obtaining the MR List of a Repository

Obtain the repository MR list.

Obtaining MR Details of a Repository

Obtain details about a repository MR.

V2Project

API

Description

Querying All Repositories of a User

Obtain information about all repositories of a user.

Creating a Project and Repository

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

RepoMember

API

Description

Obtaining All Member Records in a Repository

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

Adding a Repository Member

The calling party codehubportal adds a repository member.

Setting a Role for a Member in the Repository

Assign repository operation permissions to repository members.

Deleting a Repository Member

Delete repository members

Commit

API

Description

Querying a Commit Message of a Repository

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

Querying a Specific Commit of a Repository

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

Querying the Commit Difference Information of a Repository

Query commit difference information by commit ID.

File

API

Description

Querying File Information in a Repository

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

Verifying HTTPS Account and Password

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

Webhook

API

Description

Querying a Webhook of a Specified Repository

Obtain the repository webhook.

Adding a Hook to a Specified Repository

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

Deleting a Hook from a Specified Repository

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

Project

API

Description

Obtaining the List of Repositories that Can be Set to Public under a Project

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

Verifying a 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

Creating a Branch

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

Discussion

API

Description

Creating an MR Review

Create MR review comments.

Obtaining a Review List

Obtain the review list.

Replying to an MR Review

Reply to MR review comments.

Obtaining Review Settings

Obtain review comments.