文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ Repository/ 添加部署密钥
更新时间：2023-05-06 GMT+08:00
查看PDF
分享

添加部署密钥

功能介绍

添加部署密钥

URI

POST /v2/repositories/{repository_id}/deploy-keys

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

仓库主键id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

application

是

String

部署使用的SSH密钥的来源

can_push

是

Boolean

部署使用的SSH密钥是否可以推送代码

key

是

String

部署使用的SSH密钥

key_title

是

String

部署使用的SSH密钥名称

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

响应错误

result

Key object

响应结果

status

String

响应状态
表5 Error

参数

参数类型

描述

code

String

错误码

message

String

错误信息
表6 Key

参数

参数类型

描述

can_push

Boolean

是否允许推送

created_at

String

部署密钥新建时间

key

String

部署密钥

key_id

String

部署密钥id

最小长度：1

最大长度：40

key_title

String

部署密钥名称

请求示例

POST https://{endpoint}/v2/repositories/{repository_id}/deploy-keys

{
  "key_title" : "z00464114@SZXG4Z004641141",
  "key" : "ssh-rsa AAAAB3NzaC1yXXXXXXXX",
  "can_push" : true,
  "application" : ""
}

响应示例

状态码： 200

OK

{
  "result" : {
    "key_id" : "1034546",
    "key_title" : "z00464114@SZXG4Z004641141",
    "key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAxxxxxxxxxxxxx"
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： Repository