CodeArts Repo
CodeArts Repo
- Service Overview
- Getting Started
-
User Guide
- Process of CodeArts Repo
- Environment and Personal Settings
- Accessing CodeArts Repo Homepage
- Creating and Configuring a CodeArts Project
- Configuring Project-Level Settings for CodeArts Repo
- Managing Member Permissions
- Creating a Repository
- Migrating Code and Syncing a Repository
- Configuring Repository Settings
- Configuring a Repository
- Cloning or Downloading a Repository to a Local PC
- Uploading Code Files to CodeArts Repo
- Collaborating on a Workflow
- Committing Code to CodeArts Repo and Creating a Merge Request
- Managing Merge Requests
- Managing Code Files
- Security Management
- Best Practices
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
APIs
- SSH Key
-
Repository
- Obtaining Files in a Branch Directory
- Obtaining Repository Statistics
- Obtaining Image Files of a Specific Branch in a Repository
- Modifying the Status of a Repository Referenced by a Pipeline
- Checking Whether a User Has the Repository Administrator Permission
- Setting a Repository to Public or Private
- Obtaining the Content of a Specified File in a Specified Branch of a Repository
- Obtaining a Public Template List
- Creating a Repository
- Obtaining a Repository Short ID to Generate the Details Page URL
- Querying a Commit of a Branch by Repository or Repository Group Name
- Querying Branches of a Specified Repository
- Querying a Commit of a Repository Branch by the Repository ID
- Adding a Deploy Key
- Deleting a Deploy Key
- Obtaining the Last Commit Statistics of a Repository
- Repository Statistics
- Deleting a Repository
- Viewing a Repository Creation Status
- Querying the Tag List of a Repository
- Adding a Tag
- Querying Details About a Repository
- Obtaining the number of committed code lines
- Downloading a Repository
- Creating a Protected Branch
- Deleting a Protected Branch
- Deleting Protected Branches in Batches
- Creating a Protected Tag
- Deleting a Protected Tag
- Obtaining a Repository Branch List
- Obtaining the MR List of a Repository
- Obtaining MR Details of a Repository
- Obtaining the Repository IP Address Whitelist
- Adding the Repository IP Address Whitelist
- Modifying the Repository IP Address Whitelist
- Deleting the Repository IP Address Whitelist
- Obtaining the Changes of an MR
- Associating a Repository with a Member Group
- Locking a Repository Based on the Repository Short ID
- Unlocking a Repository Based on the Repository Short ID
- Approving an MR
- Obtaining Associated Work Item Information
- Obtaining Reviewer Information Based on the Repo Short ID and Merge Request Short ID
- Obtaining the List of Changed Files
- Tenant
- Group
- Project (V2)
- RepoMember
- Commit
- File
- User
- Webhook
- Project
- Repository Management (V2)
- Review
- Application Examples
- Appendix
-
FAQs
- Authentication
- Member Permissions
-
Uploading and Downloading Code
- "Error: Deny by project hooks setting 'default': message of commit" Is Reported When Code Repository Is Pushed from the Local Host to CodeArts Repo
- Pushing Binary Files to CodeArts Repo Failed
- Error "'origin' does not appear to be a git repository..." Is Reported When the Git Push Command Is Executed
- Error "The requested URL returned error: 401" Is Reported When HTTPS Is Used to Clone Code in CentOS
- Error "Merge branch 'master' of https://test.com Please Enter a commit" Is Reported When Pulling Code Using the Git Pull Command
- Client Disconnects When a File Is Pushed
- Message "fatal: refusing to merge unrelated histories" Is Displayed
- How Do I Prevent Files Containing Secrets from Being Pushed to CodeArts Repo?
- Migrating Repositories
- Merge Request
- Fork Sync
- Repository Capacity
- FAQs
On this page
Help Center/
CodeArts Repo/
API Reference/
APIs/
SSH Key/
Checking Whether a Private Key Can Be Used to Pull Code
Checking Whether a Private Key Can Be Used to Pull Code
Updated on 2025-05-15 GMT+08:00
Function
This API is used to check whether a private key has permission to pull code from a repository.
URI
POST /v1/users/sshkey/privatekey/verify
Request 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: None Range: 1–100,000 characters. Default value: None |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
repository_uuid |
Yes |
String |
Explanation: Repo UUID, which is returned by the CreateRepository API. Range: 32 digits and letters. |
|
private_key |
Yes |
String |
Explanation: Key, which is uploaded by a user. Range: Max. 2,048 digits. |
Response Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
error |
Error object |
Explanation: Response error. Range: None |
|
result |
String |
Explanation: Response result. Range: None |
|
status |
String |
Explanation: Response status of the API. Range:
|
Example Requests
POST https://{endpoint}/v1/users/sshkey/privatekey/verify
{
"private_key" : "-----BEGIN RSA PRIVATE KEY-----****-----END RSA PRIVATE KEY-----",
"repository_uuid" : "9b2fab276e9240e09cd01ed0400fc439"
}Example Responses
Status code: 200
OK
{
"status" : "success"
}Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
Error Codes
See Error Codes.
Parent topic: SSH Key
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
The system is busy. Please try again later.
