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

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

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

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. Value range: 1~2147483647

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. 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.

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.

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

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

Status code: 200

{
  "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."
}

Parent topic: ThirdParty

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.