Create a public SSH key for the authenticated user

POST

/user/keys

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.github.com/user/keys' \
--header 'Content-Type: application/json' \
--data-raw '{
    "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
    "title": "ssh-rsa AAAAB3NzaC1yc2EAAA"
}'

Response Example

201 - Example 1

{
    "created_at": "2019-08-24T14:15:22Z",
    "id": 0,
    "key": "string",
    "read_only": true,
    "title": "string",
    "url": "string",
    "verified": true
}

Request

Body Params application/json

key

string

required

The public SSH key to add to your GitHub account.

Match pattern:

^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521)

title

string

optional

A descriptive name for the new key.

Example:

Personal MacBook Air

Examples

Responses

🟢201Response

application/json

Body

Key

created_at

string <date-time>

required

integer

required

key

string

required

read_only

boolean

required

title

string

required

url

string

required

verified

boolean

required

🔵304304

🟠401401

🟠403403

🟠404404

🟠422422

Modified at 2023-08-15 02:59:30

List public SSH keys for the authenticated user

Delete a public SSH key for the authenticated user