Octokit Rest API

Check if a gist is starred

octokit.gists.checkIsStarred({
  gist_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Create a gist

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.

octokit.gists.create({
        files,
files.*.content
      })

Parameters

See also: GitHub Developer Guide documentation.

Create a gist comment

octokit.gists.createComment({
  gist_id,
  body,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a gist

octokit.gists.delete({
  gist_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Delete a gist comment

octokit.gists.deleteComment({
  gist_id,
  comment_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Fork a gist

Note: This was previously /gists/:gist_id/fork.

octokit.gists.fork({
  gist_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a gist

octokit.gists.get({
  gist_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a gist comment

octokit.gists.getComment({
  gist_id,
  comment_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Get a gist revision

octokit.gists.getRevision({
  gist_id,
  sha,
});

Parameters

See also: GitHub Developer Guide documentation.

List gists for the authenticated user

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

octokit.gists.list();

Parameters

See also: GitHub Developer Guide documentation.

List gist comments

octokit.gists.listComments({
  gist_id,
});

Parameters

See also: GitHub Developer Guide documentation.

List gist commits

octokit.gists.listCommits({
  gist_id,
});

Parameters

See also: GitHub Developer Guide documentation.

List gist forks

octokit.gists.listForks({
  gist_id,
});

Parameters

See also: GitHub Developer Guide documentation.

List gists for a user

Lists public gists for the specified user:

octokit.gists.listForUser({
  username,
});

Parameters

See also: GitHub Developer Guide documentation.

List public gists

List public gists sorted by most recently updated to least recently updated.

Note: With pagination, 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.

octokit.gists.listPublic();

Parameters

See also: GitHub Developer Guide documentation.

List starred gists

List the authenticated user's starred gists:

octokit.gists.listStarred();

Parameters

See also: GitHub Developer Guide documentation.

Star a gist

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

octokit.gists.star({
  gist_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Unstar a gist

octokit.gists.unstar({
  gist_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Update a gist

Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.

octokit.gists.update({
  gist_id,
});

Parameters

See also: GitHub Developer Guide documentation.

Update a gist comment

octokit.gists.updateComment({
  gist_id,
  comment_id,
  body,
});

Parameters

See also: GitHub Developer Guide documentation.