Help Center/ CodeArts Repo/ API Reference (Ally Region)/ APIs/ SSHKey/ Checking Whether a Private Key Can Be Used to Pull Code
Updated on 2026-01-08 GMT+08:00
View PDF
Share

Checking Whether a Private Key Can Be Used to Pull Code

Description

This API is used to check whether a private key can be used to pull code.

URI

POST /v1/users/sshkey/privatekey/verify

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

repository_uuid

Yes

String

Repository UUID returned by the CreateRepository API

Minimum length: 32

Maximum length: 32

private_key

Yes

String

Private key

Minimum length: 0

Maximum length: 2,048

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error

Error object

Response error

result

String

Response result

status

String

Response status
Table 4 Error

Parameter

Type

Description

code

String

Error codes

message

String

Error message

Request Examples

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

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

Response Examples

Status code: 200

Request succeeded

{
  "status" : "success"
}

Status Codes

Status Codes

Description

200

Request succeeded

Error Codes

See Error Codes.

Parent topic: SSHKey