Help Center/ CodeArts Repo/ API Reference/ APIs/ SSH Key/ Checking Whether a Private Key Can Be Used to Pull Code

Updated on 2026-01-27 GMT+08:00

View PDF

Checking Whether a Private Key Can Be Used to Pull Code

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

**Table 1** Request header parameter
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

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
repository_uuid	Yes	String	Explanation Repository UUID. For details, see the UUID returned by Querying the Details About a Repository. Constraints None Range 32 digits and letters. Default value None
private_key	Yes	String	Explanation Key, which is uploaded by a user. Constraints None Range Max. 2,048 digits. Default value None

Response Parameters

**Table 3** Response body 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 success: The API call is successful. failed: The API call failed.

**Table 4** Error
Parameter	Type	Description
code	String	Explanation Error code returned when the API fails to be called. Range Max. 100 characters in the error code format.
message	String	Explanation Error message returned when the API fails to be called. Range None

Example Requests

POST https://{endpoint}/v1/users/sshkey/privatekey/verify

{
  "private_key":"-----BEGIN RSA PRIVATE KEY-----****-----END RSA PRIVATE KEY-----",
  "repository_uuid":"9b2fab276e9240e09cd01ed0400fc439"
}