デプロイキー

Deploy keys APIを使うと、デプロイキーの生成と管理ができます。

Deploy keys APIについて

You can launch projects from a repository on GitHub AE to your server by using a deploy key, which is an SSH key that grants access to a single repository. GitHub AE attaches the public part of the key directly to your repository instead of a personal account, and the private part of the key remains on your server. 詳しい情報については「デプロイメントのデリバリー」を参照してください。

デプロイキーは、以下の API エンドポイントを使用するか、GitHub を使用することでセットアップできます。 GitHub でデプロイキーを設定する方法については、「デプロイキーを管理する」を参照してください。

List deploy keys

Works with GitHub Apps

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`owner`string必須 The account owner of the repository. The name is not case sensitive.
`repo`string必須 The name of the repository. The name is not case sensitive.
クエリパラメータ
名前, 種類, 説明
`per_page`integer The number of results per page (max 100). デフォルト: `30`
`page`integer Page number of the results to fetch. デフォルト: `1`

HTTP response status codes

Status code	説明
`200`	OK

コードサンプル

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

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://HOSTNAME/api/v3/repos/OWNER/REPO/keys

Response

Status: 200

[
  {
    "id": 1,
    "key": "ssh-rsa AAA...",
    "url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
    "title": "octocat@octomac",
    "verified": true,
    "created_at": "2014-12-10T15:53:42Z",
    "read_only": true
  }
]

Create a deploy key

Works with GitHub Apps

You can create a read-only deploy key.

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`owner`string必須 The account owner of the repository. The name is not case sensitive.
`repo`string必須 The name of the repository. The name is not case sensitive.
Body parameters
名前, 種類, 説明
`title`string A name for the key.
`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."

HTTP response status codes

Status code	説明
`201`	Created
`422`	Validation failed

コードサンプル

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

curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://HOSTNAME/api/v3/repos/OWNER/REPO/keys \
  -d '{"title":"octocat@octomac","key":"ssh-rsa AAA...","read_only":true}'

Response

Status: 201

{
  "id": 1,
  "key": "ssh-rsa AAA...",
  "url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
  "title": "octocat@octomac",
  "verified": true,
  "created_at": "2014-12-10T15:53:42Z",
  "read_only": true
}

Get a deploy key

Works with GitHub Apps

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`owner`string必須 The account owner of the repository. The name is not case sensitive.
`repo`string必須 The name of the repository. The name is not case sensitive.
`key_id`integer必須 The unique identifier of the key.

HTTP response status codes

Status code	説明
`200`	OK
`404`	Resource not found

コードサンプル

get/repos/{owner}/{repo}/keys/{key_id}

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://HOSTNAME/api/v3/repos/OWNER/REPO/keys/KEY_ID

Response

Status: 200

{
  "id": 1,
  "key": "ssh-rsa AAA...",
  "url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
  "title": "octocat@octomac",
  "verified": true,
  "created_at": "2014-12-10T15:53:42Z",
  "read_only": true
}

Delete a deploy key

Works with GitHub Apps

Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

パラメータ

Headers
名前, 種類, 説明
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
名前, 種類, 説明
`owner`string必須 The account owner of the repository. The name is not case sensitive.
`repo`string必須 The name of the repository. The name is not case sensitive.
`key_id`integer必須 The unique identifier of the key.

HTTP response status codes

Status code	説明
`204`	No Content

コードサンプル

delete/repos/{owner}/{repo}/keys/{key_id}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://HOSTNAME/api/v3/repos/OWNER/REPO/keys/KEY_ID

Response

Status: 204