Get a deploy key | GitHub API (unofficial showcase)

3 parameters

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The repository name without the `.git` extension. The name is not case sensitive.

key_idintegerrequired

The unique identifier of the deploy key.

2 status codes

200Returns the deploy key object, including its ID, key, title, verification status, creation time, and access mode.

idintegerrequired

keystringrequired

urlstringrequired

titlestringrequired

verifiedbooleanrequired

created_atstringrequired

read_onlybooleanrequired

added_bystringoptional

last_usedstringoptional

enabledbooleanoptional

404Returned when the requested resource cannot be found.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned when the deploy key cannot be found in the specified repository. The owner path parameter and repo path parameter must identify the repository, and the key_id path parameter must identify its deploy key.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.keys.get({
  owner: "octocat",
  repo: "hello-world",
  keyId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{
  "id": 1,
  "key": "ssh-rsa AAA...",
  "url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
  "title": "octocat@octomac",
  "verified": true,
  "created_at": "2014-12-10T15:53:42Z",
  "read_only": true,
  "added_by": "octocat",
  "last_used": "2022-01-10T15:53:42Z",
  "enabled": true
}

Request

Response

Errors