Sample - GitHub REST API
GET/repos/{owner}/{repo}/keys

List deploy keys

Lists the deploy keys configured for a repository. Use page and per_page to paginate the results; per_page can be at most 100.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

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 deploy keys to return per page. Defaults to 30 when omitted and must not exceed 100.
Default:30
pageintegeroptional
The page number to retrieve. Defaults to 1 when omitted.
Default:1

1 status code
200Returns an array of deploy key objects containing each key's identifier, contents, title, verification status, creation time, access mode, and availability details.
idintegerrequired
keystringrequired
urlstringrequired
titlestringrequired
verifiedbooleanrequired
created_atstringrequired
read_onlybooleanrequired
added_bystringoptional
last_usedstringoptional
enabledbooleanoptional

Error handling

owner and repo must identify the repository whose deploy keys you want to list. per_page must not exceed 100, and page must identify the page to retrieve.