デプロイキー

REST API を使って、デプロイキーの作成と管理を行います。

デプロイキーについて

GitHub AE のリポジトリからプロジェクトをサーバーに起動するには、デプロイキーを使用します。これは、単一のリポジトリへのアクセスを許可する SSH キーです。 GitHub AE は個人アカウントの代わりに、リポジトリに直接キーのパブリックな部分をアタッチし、キーのプライベートな部分はサーバーに残ります。詳細については、「デプロイを配信する」を参照してください。

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

List deploy keys

Works with GitHub Apps

Parameters

Headers
名前, Type, 説明
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
名前, Type, 説明
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
Query parameters
名前, Type, 説明
`per_page`integer The number of results per page (max 100). Default: `30`
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes

Status code	説明
`200`	OK

Code samples

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

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

Response

Status: 200

{}

Create a deploy key

Works with GitHub Apps

You can create a read-only deploy key.

Parameters

Headers
名前, Type, 説明
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
名前, Type, 説明
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
Body parameters
名前, Type, 説明
`title`string A name for the key.
`key`stringRequired 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, or the endpoint has been spammed.

Code samples

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

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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

Parameters

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

HTTP response status codes

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

Code samples

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

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-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.

Parameters

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

HTTP response status codes

Status code	説明
`204`	No Content

Code samples

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

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

Response

Status: 204

デプロイ キー