Skip to main content
설명서에 자주 업데이트를 게시하며 이 페이지의 번역이 계속 진행 중일 수 있습니다. 최신 정보는 영어 설명서를 참조하세요.

Git SSH 키

REST API를 사용하여 인증된 사용자의 Git SSH 키를 관리합니다.

Git SSH 키 관리 정보

요청 URL에 매개 변수가 {username} 포함되어 있지 않으면 로그인한 사용자에 대한 응답이 됩니다.{ % ifversion fpt or ghes or ghec %} 사용자가 2단계 인증을 사용할 수 있는지 여부와 같은 추가 개인 정보는 기본 인증 또는 OAuth user 를 통해 인증될 때 범위에 포함됩니다.{ % endif %}

List public SSH keys for the authenticated user

Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.

"List public SSH keys for the authenticated user"에 대한 매개 변수

헤더
속성, 형식, Description
accept string

Setting to application/vnd.github+json is recommended.

쿼리 매개 변수
속성, 형식, Description
per_page integer

The number of results per page (max 100).

기본값: 30

page integer

Page number of the results to fetch.

기본값: 1

"List public SSH keys for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드Description
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

"List public SSH keys for the authenticated user"에 대한 코드 샘플

get/user/keys
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/user/keys

Response

Status: 200
[ { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, "url": "https://HOSTNAME/user/keys/2", "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", "created_at": "2020-06-11T21:31:57Z", "verified": false, "read_only": false }, { "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", "id": 3, "url": "https://HOSTNAME/user/keys/3", "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", "created_at": "2020-07-11T21:31:57Z", "verified": false, "read_only": false } ]

Create a public SSH key for the authenticated user

Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:public_key scope.

"Create a public SSH key for the authenticated user"에 대한 매개 변수

헤더
속성, 형식, Description
accept string

Setting to application/vnd.github+json is recommended.

본문 매개 변수
속성, 형식, Description
title string

A descriptive name for the new key.

key string 필수

The public SSH key to add to your GitHub account.

"Create a public SSH key for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드Description
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

"Create a public SSH key for the authenticated user"에 대한 코드 샘플

post/user/keys
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/user/keys \ -d '{"title":"ssh-rsa AAAAB3NzaC1yc2EAAA","key":"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"}'

Response

Status: 201
{ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, "url": "https://HOSTNAME/user/keys/2", "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", "created_at": "2020-06-11T21:31:57Z", "verified": false, "read_only": false }

Get a public SSH key for the authenticated user

View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.

"Get a public SSH key for the authenticated user"에 대한 매개 변수

헤더
속성, 형식, Description
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
속성, 형식, Description
key_id integer 필수

The unique identifier of the key.

"Get a public SSH key for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드Description
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

"Get a public SSH key for the authenticated user"에 대한 코드 샘플

get/user/keys/{key_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/user/keys/KEY_ID

Response

Status: 200
{ "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", "id": 2, "url": "https://HOSTNAME/user/keys/2", "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", "created_at": "2020-06-11T21:31:57Z", "verified": false, "read_only": false }

Delete a public SSH key for the authenticated user

Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope.

"Delete a public SSH key for the authenticated user"에 대한 매개 변수

헤더
속성, 형식, Description
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
속성, 형식, Description
key_id integer 필수

The unique identifier of the key.

"Delete a public SSH key for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드Description
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

"Delete a public SSH key for the authenticated user"에 대한 코드 샘플

delete/user/keys/{key_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/user/keys/KEY_ID

Response

Status: 204

List public keys for a user

에서 작동 GitHub Apps

Lists the verified public SSH keys for a user. This is accessible by anyone.

"List public keys for a user"에 대한 매개 변수

헤더
속성, 형식, Description
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
속성, 형식, Description
username string 필수

The handle for the GitHub user account.

쿼리 매개 변수
속성, 형식, Description
per_page integer

The number of results per page (max 100).

기본값: 30

page integer

Page number of the results to fetch.

기본값: 1

"List public keys for a user"에 대한 HTTP 응답 상태 코드

상태 코드Description
200

OK

"List public keys for a user"에 대한 코드 샘플

get/users/{username}/keys
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/users/USERNAME/keys

Response

Status: 200
[ { "id": 1, "key": "ssh-rsa AAA..." } ]