API Overview
SSH Key
| API | Description |
|---|---|
| Obtain the SSH key list. | |
| Add an SSH key. | |
| Check whether a private key has the permission to pull code. |
Repository
| API | Description |
|---|---|
| Obtain files in the branch directory. | |
| Obtain repository statistics. | |
| 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. |
| 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. |
| Obtain the list of public sample templates. | |
| 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. |
| 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. |
| Add a deployment key. | |
| Delete the repository deployment key. | |
| Obtain the last commit statistics of the repository. | |
| Query code commit record statistics of a repository based on the repository short ID. | |
| Delete a repository based on the 32-bit UUID of the repository. | |
| Obtain the repository status. | |
| Query the branch corresponding to a specified repository. | |
| Create a tag. | |
| Obtain repository information based on the repository UUID. The returned information contains the ID, name, group name, and repository access URL. | |
| Obtain the number of committed code lines of a specified branch in the code repository on a specified date. | |
| Download a repository in the specified format. | |
| Create a protection branch. | |
| Obtain the repository branch list. | |
| Obtain the repository MR list. | |
| Obtain details about a repository MR. |
V2Project
| API | Description |
|---|---|
| Obtain information about all repositories of a user. | |
| 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. | |
| After a repository is created, parameters transferred to the fork repository include the repository name, whether to import project members, and home 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. | |
| Associate a branch with a work item. |
RepoMember
| API | Description |
|---|---|
| Obtain the repository member list. You can search for a member by keyword. | |
| The calling party codehubportal adds a repository member. | |
| Assign repository operation permissions to repository members. | |
| Delete repository members |
Commit
| API | Description |
|---|---|
| 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. | |
| 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. | |
| Obtain a specific commit by commit ID, branch name, or tag name. | |
| Query commit difference information by commit ID. |
File
| API | Description |
|---|---|
| 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 |
|---|---|
| Check whether the username and password entered when you upload or download code using HTTPS are valid. |
Webhook
| API | Description |
|---|---|
| Obtain the repository webhook. | |
| A code commit automatically triggers building and addition of a repository hook. | |
| 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. |
| 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 a branch in a specified repository based on the repository ID. |
Discussion
| API | Description |
|---|---|
| Create MR review comments. | |
| Obtain the review list. | |
| Reply to MR review comments. | |
| Obtain review comments. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.