List deploy keys

GET/repos/{owner}/{repo}/keys

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

Request

Path Parameters

owner string required
repo string required

Query Parameters

per_page integer optional: Results per page (max 100)
page integer optional: Page number of the results to fetch.

Responses

application/json array[Deploy Key object]

Response

Headers

Link string

Example:

<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"

items Deploy Key object

An SSH key granting access to a single repository.

created_at string

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": "2014-12-10T15:53:42Z",
    "id": 1,
    "key": "ssh-rsa AAA...",
    "read_only": true,
    "title": "octocat@octomac",
    "url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
    "verified": true
  }
]

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

owner *

repo *

per_page

Results per page (max 100)

page

Page number of the results to fetch.

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/repos/{owner}/{repo}/keys