Create a public SSH key for the authenticated user

POST /user/keys

Copy endpoint

https://api.github.com

Adds a public SSH key to the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the write:public_key scope to use this endpoint.

Request Body

application/json required

{ title?: string;key: string; }

Responses

201 application/json

Response

interface Key {
key: string;
id: number;
url: string;
title: string;
created_at: string;
verified: boolean;
read_only: boolean;
last_used?: string | null;
}

Redirects

304

Not modified

unknown

Client Errors

401 application/json

Requires authentication

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}

403 application/json

Forbidden

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}

404 application/json

Resource not found

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}

422 application/json

Validation failed, or the endpoint has been spammed.

interface ValidationError {
message: string;
documentation_url: string;
errors?: {
resource?: string;
field?: string;
message?: string;
code: string;
index?: number;
value?: string[] | string | number | null;
}[];
}