Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ ThirdParty/ Checking Whether the Deploy Key of the Repository Group Is Configured in the Upper-Layer Repository Group or Project
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Checking Whether the Deploy Key of the Repository Group Is Configured in the Upper-Layer Repository Group or Project

Function

This API is used to check whether the deployment key of a repository group is configured in the upper-layer repository group or project.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo:group:getGroup

Read

-

-

-

-

URI

POST https://{hostURL}/v4/groups/{group_id}/deploy-keys/check-key

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

group_id

Yes

Integer

Definition

Repository group ID, which is the numeric ID next to Group ID on the repository group homepage.

Default Value

N/A

Value range:

1~2147483647

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

key

No

String

Definition

Key value to be checked.

Range

1–5,000 characters.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

exists

Boolean

Definition:

Whether the deploy key is configured in the upper-layer repository group or project.

Value range:

  • true: configured in the upper-layer repository group or project.

  • false: not configured in the upper-layer repository group or project.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

POST https://{endpoint}/v4/groups/1/deploy-keys/check-key

{
  "key" : "ssh-rsa AAAAB3Nza*********************gdcdvS8= zhangsan@DESKTOP-12MP13A"
}

Example Responses

Status code: 200

OK

{
  "exists" : false
}

Status code: 401

Unauthorized

{
  "error_code" : "CH.00000002",
  "error_msg" : "Recognize authentication information failed."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.00401008",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status code: 404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "The repository does not exist. Check and try again."
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Bad Request

404

Not Found

Error Codes

See Error Codes.

Parent topic: ThirdParty