Gists

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

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!

Actions

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

Gists - GitHub AE Docs

Use the REST API to list, create, update and delete the public gists on GitHub AE.

Quickstart

Comparing GitHub's APIs

Resources in the REST API

Rate limits

Media types

Authenticating

Keeping API credentials secure

Troubleshooting

Libraries

Issue event types

GitHub event types

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Permissions for GitHub Apps

Overview

Using the API

Script with JavaScript

Script with Ruby

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Pagination

Building a CI server

Best practices

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

OAuth Authorizations

Webhooks

Apps

Branches

Protected branches

Check Runs

Check Suites

Checks

Code Scanning

Codes of conduct

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Deploy keys

Deployment branch policies

Deployments

Environments

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Global Webhooks

License

Organizations

Pre-receive Environments

Users

Enterprise administration

Comments

Blobs

References

Trees

Git database

Gitignore

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

Members

Outside Collaborators

Pages

Boards

Cards

Columns

Project boards

Pulls

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release Assets

Autolinks

Forks

Git LFS

Repositories

Search

Secret scanning

Teams

Discussion comments

Discussions

External groups

Followers

GPG Keys

Git SSH Keys

Base Gist

Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:

Only show results that were last updated after the given time. This is a timestamp in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a> format: <code>YYYY-MM-DDTHH:MM:SSZ</code>.

since

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

List gists for the authenticated user

description

content

A user-defined key to represent an item in <code>files</code>.

Names and content for the files that make up the gist

files

Flag indicating whether the gist is public

public

Gist

Simple User

Gist Simple

Allows you to add a new gist with one or more files.
Note: Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.

Validation failed, or the endpoint has been spammed.

Create a gist

List public gists sorted by most recently updated to least recently updated.
Note: With <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api">pagination</a>, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

List public gists

List the authenticated user's starred gists:

List starred gists

The unique identifier of the gist.

gist_id

Get a gist

filename

The gist files to be updated, renamed, or deleted. Each <code>key</code> must match the current filename
(including extension) of the targeted gist file. For example: <code>hello.py</code>.
To delete a file, set the whole file to null. For example: <code>hello.py : null</code>. The file will also be
deleted if the specified object does not contain at least one of <code>content</code> or <code>filename</code>.

Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
At least one of <code>description</code> or <code>files</code> is required.

Update a gist

Delete a gist

Gist Commit

List gist commits

List gist forks

Fork a gist

Check if a gist is starred

Note that you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see "<a href="https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs">HTTP verbs</a>."