Public Keys
- List public keys for a user
- List your public keys
- Get a single public key
- Create a public key
- Update a public key
- Delete a public key
List public keys for a user
GET /users/:username/keys
Lists the verified public keys for a user. This is accessible by anyone.
Response
Status: 200 OK
Link: <https://api.github.com/resource?page=2>; rel="next",
<https://api.github.com/resource?page=5>; rel="last"
[
{
"id": 1,
"key": "ssh-rsa AAA..."
}
]
List your public keys
GET /user/keys
Lists the current user's keys. Requires that you are authenticated via
Basic Auth or via OAuth with at least read:public_key
scope.
Response
Status: 200 OK
Link: <https://api.github.com/resource?page=2>; rel="next",
<https://api.github.com/resource?page=5>; rel="last"
[
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/user/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true
}
]
Get a single public key
View extended details for a single public key. Requires that you are
authenticated via Basic Auth or via OAuth with at least read:public_key
scope.
GET /user/keys/:id
Response
Status: 200 OK
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/user/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true
}
Create a public key
Creates a public key. Requires that you are authenticated via Basic Auth,
or OAuth with at least write:public_key
scope.
POST /user/keys
Input
{
"title": "octocat@octomac",
"key": "ssh-rsa AAA..."
}
Response
Status: 201 Created
Location: https://api.github.com/user/keys/1
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/user/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true
}
Update a public key
Public keys are immutable. If you need to update a public key, remove the key and create a new one instead.
Delete a public key
Removes a public key. Requires that you are authenticated via Basic Auth
or via OAuth with at least admin:public_key
scope.
DELETE /user/keys/:id
Response
Status: 204 No Content