Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ ThirdParty/ Obtaining the Deployment Key List of a Repository Group
Updated on 2026-04-28 GMT+08:00
View PDF

Obtaining the Deployment Key List of a Repository Group

Function

This API is used to obtain the deployment key list of a repository group.

Debugging

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

URI

GET https://{hostURL}/v4/groups/{group_id}/deploy-keys

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 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Offset, which starts from 0.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Definition

Number of returned records.

Value range:

1~100

Default value:

20

Request Parameters

Table 3 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.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Total

String

Definition:

Total number of results of the current request.
Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of DeployKeyDto objects

Definition:

Deployment key object.
Table 6 DeployKeyDto

Parameter

Type

Description

id

Integer

Definition:

Deployment key ID.

Value range:

1~2147483647

title

String

Definition:

Deployment key title.

fingerprint

String

Definition:

Deployment key fingerprint.

created_at

String

Definition:

Creation time.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/groups/1/deploy-keys

Example Responses

Status code: 200

OK

[ {
  "id" : 1,
  "title" : "demo",
  "fingerprint" : "16:e4:e2:16:6d:38:dd:29:8e:48:6b:07:09:cf:37:fd",
  "created_at" : "2025-06-14T20:30:10.000+08:00"
} ]

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

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

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.

Parent topic: ThirdParty