GitHub API

Create a deploy key

POST

/repos/{owner}/{repo}/keys

repos

You can create a read-only deploy key.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.github.com/repos///keys' \
--header 'Content-Type: application/json' \
--data-raw '{
    "key": "ssh-rsa AAA...",
    "read_only": true,
    "title": "octocat@octomac"
}'

响应示例

201 - 示例 1

{
  "created_at": "string",
  "id": 0,
  "key": "string",
  "read_only": true,
  "title": "string",
  "url": "string",
  "verified": true
}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

Body 参数application/json

key

string

必需

The contents of the key.

read_only

boolean

可选

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "Repository permission levels for an organization" and "Permission levels for a user account repository."

title

string

可选

A name for the key.

示例

返回响应

🟢201Response

application/json

Body

An SSH key granting access to a single repository.

created_at

string

必需

integer

必需

key

string

必需

read_only

boolean

必需

title

string

必需

url

string

必需

verified

boolean

必需

🟠422422

List deploy keys

Delete a deploy key