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](https://docs.github.com/[email protected]/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

GET/user/keys/{key_id}

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

key_id integer required: key_id parameter

Responses

application/json Key object

Response

created_at string<date-time>

required

id integer

required

key string

required

read_only boolean

required

title string

required

url string

required

verified boolean

required

Response Example: 200 application/json

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

Not modified

application/json Basic Error object

Requires authentication

documentation_url string

optional

message string

optional

status string

optional

url string

optional

application/json Basic Error object

Forbidden

documentation_url string

optional

message string

optional

status string

optional

url string

optional

application/json Basic Error object

Resource not found

documentation_url string

optional

message string

optional

status string

optional

url string

optional

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

key_id *

key_id parameter

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/user/keys/{key_id}