REST API endpoints for deploy keys

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.12

Enterprise Server 3.13

Enterprise Server 3.14

Free, Pro, & Team

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Domain name

Who can use this feature?

Actions

Multiple permissions are required, or a different permission may be used. For more information about the permissions, see the documentation for this endpoint.

Enter a search term to find it in the GitHub Docs.

REST API endpoints for deploy keys - GitHub Enterprise Server 3.11 Docs

Use the REST API to create and manage deploy keys.

Quickstart

About the REST API

Comparing GitHub's APIs

API Versions

Breaking changes

OpenAPI description

Getting started

Rate limits

Pagination

Libraries

Best practices

Troubleshooting

Timezones

CORS and JSONP

Issue event types

GitHub event types

Using the REST API

Authenticating

Keeping API credentials secure

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Endpoints for fine-grained PATs

Permissions for GitHub Apps

Permissions for fine-grained PATs

Authentication

Script with JavaScript

Script with Ruby

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Building a CI server

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Cache

OIDC

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Variables

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

Organization

Announcement banners

GitHub Apps

Installations

OAuth authorizations

Webhooks

Apps

Billing

Branches

Protected branches

Check runs

Check suites

Checks

Code scanning

Codes of conduct

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Alerts

Dependabot

Dependency review

Dependency submission

Software bill of materials (SBOM)

Dependency graph

Deploy keys

Deployment branch policies

Deployments

Environments

Protection rules

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Code security and analysis

Global webhooks

LDAP

License

Manage GHES

Management Console

Organization pre-receive hooks

Organizations

Pre-receive environments

Pre-receive hooks

Repository pre-receive hooks

SCIM

Users

Enterprise administration

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

OAuth app authorizations

Custom roles

Members

Outside collaborators

Personal access tokens

Rules

Security managers

Packages

Pages

Boards

Cards

Columns

Projects (classic)

Pull requests

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release assets

Autolinks

Forks

Git LFS

Repositories

Search

Secret scanning

Global security advisories

Security advisories

Teams

Discussion comments

Discussions

External groups

Emails

Followers

GPG keys

Git SSH keys

Social accounts

SSH signing keys

octocat@octomac

An SSH key granting access to a single repository.

Deploy Key

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

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

The number of results per page (max 100). For more information, see "<a href="https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

per_page

The page number of the results to fetch. For more information, see "<a href="https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api">Using pagination in the REST API</a>."

page

List deploy keys

title

If <code>true</code>, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "<a href="https://docs.github.com/enterprise-server@3.11/articles/repository-permission-levels-for-an-organization/">Repository permission levels for an organization</a>" and "<a href="https://docs.github.com/enterprise-server@3.11/articles/permission-levels-for-a-user-account-repository/">Permission levels for a user account repository</a>."

read_only

You can create a read-only deploy key.

Validation failed, or the endpoint has been spammed.

Create a deploy key

key_id

Get a deploy key

Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.

Delete a deploy key