List deploy keys for a repository | GitHub API (unofficial showcase)

4 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.

per_pageintegeroptional

The number of results per page, up to 100. Defaults to 30 when omitted.

Default:30

pageintegeroptional

The page number of results to fetch. Defaults to 1 when omitted.

Default:1

1 status code

200Returns an array of deploy key objects, each containing the key, title, verification status, creation time, and access mode.

idintegerrequired

keystringrequired

urlstringrequired

titlestringrequired

verifiedbooleanrequired

created_atstringrequired

read_onlybooleanrequired

added_bystringoptional

last_usedstringoptional

enabledbooleanoptional

Error handling

The owner path parameter and repo path parameter must identify a repository with deploy keys; per_page accepts at most 100, and page and per_page default to 1 and 30 respectively when omitted. Use page and per_page to paginate the results.

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

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

const result = await client.keys.list({
  owner: "octocat",
  repo: "hello-world",
  perPage: 20,
  page: 1,
});

[
  {
    "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